jhkennedy / collabme

Get all your collaborators from a bibtex file for NSF proposals

Hi, I'm Joe. 👋 He/him.

I'm a Staff Scientist at the Alaska Satellite Facility, a Computational Glaciologist, a Climate Scientist, and an Adventurer living/playing in Alaska ⛄.

I develop (primarily) python-based, open-source scientific software and focus on scientific workflows that scale from laptops to HPCs or the Cloud.

Technologies

collabme's Issues

Use other input file formats

Pybtex can already parse multiple file formats, but there are many others used by citation managers as well:

• BibTeX
• BibTeXML
• YAML
• EndNote Library (.enl)
• Ref Man RIS
• Others?

This ability also needs to be exposed to the users.

Ensure all optional arguments are optional

All arguments to the CLI (clbme) that are classified as optional should be optional, or have a default value.

Packaging structure

Finish python packaging structure so collabMe can be distributed via pypi.

Confirm python 2 and 3 compatibility

Many scientific modeling centers are still using python 2 as the default, so compatibility is needed. (I'm looking at you HPC crowd)

These versions should be targeted:

• Py 2.7
• Py 3.5
• Py 3.6

use other sources of info

ORCID, scholar, might be other options with half-decent APIs to pull collaborators from. There are certainly a few scholar APIs that search for authors, return papers; if they returned this information in the form of a bib-file, like scholar allows for individual entries, integration of this source would be quite easy.

Use years for time limit

Because the the bibtex files really only reliably store publication year info, the time limit for adding collaborators should be given in years.

Suggest adding a mutually exclusive argument group with the current max_months option as well as a max_years option.

Then, the max_month option can set the max_years through an action, and the comparison will be clearer.

Note: max_month description needs to make this clear.

option to limit to past 48 months

that's all NSF wants, should be a parameter though.

Formatting option for output

Allow for different formatting options of output:

• Latex
• HTML
• Text
• MS Word? (eww)
• Markdown
• ReStructuredText

Also, instead of just one name-per-line, users may want:

• name-per-line
• bulleted list
• numbered list
• paragraph style

find current affiliation

that might be a tad harder - google?

Source multiple bibtex files

CollabMe should be able to parse authors from multiple bibtex files for flexibility (e.g., may be useful if people keep a bibtex for specific sections of a CV).

• The -b/--bibtex option should be modified to take in multiple files
• The bibtex files are parsed and collated