citationhelper
This is a utility that generates a list of all packages imported into python scripts (*.py) in a given list of directories. It is intended to be used to help keep track of community software used in research projects so that the packages can be properly cited in publications. The utility works by first walking the named directories and identifying *.py files, then searching these files for import statements.
Installation
citationhelper can be installed via pip
pip install citationhelper
Alternatively, citationhelper can be installed from github
pip install git+https://github.com/EarthCubeInGeo/citationhelper.git
After installing, set the environment variable CITEHELP_REFFILE if you want to use a custom JSON library of full citations. The utility will work without this, but it can only generate a list of package names with no citation information.
export CITEHELP_REFFILE=filename
Usage
Run citationhelper with the citehelp command followed by a list of the directories to search for import statements and print a report to the screen.
citehelp project_directory
WARNING: This tool was developed to assist researchers in keeping track of software packages, but it is HIGHLY recommended users review the list of packages produced.
3 maintainers
Metadata
3 maintainers
Release files for citationhelper 0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| citationhelper-0.4.tar.gz | 16.4 kB | Without provenance | Details for citationhelper-0.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| citationhelper-0.4-py3-none-any.whl | Python 3 | none | any | Details for citationhelper-0.4-py3-none-any.whl |
Total release size: 33.4 kB
Release files / citationhelper-0.4.tar.gz
| Download URL | citationhelper-0.4.tar.gz |
|---|---|
| Size | 16.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9c0ea1edc9edc5580673bac3a85f1457e2a36abb0e74e823e9da74368cd37ee1
|
|
BLAKE2b-256 checksum How to use checksums |
c6d7fd3add08334d822e88f8683331d403f2564b8bc126cd36e57d0dcfd109fd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6
|
Release files / citationhelper-0.4-py3-none-any.whl
| Download URL | citationhelper-0.4-py3-none-any.whl |
|---|---|
| Size | 17.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d81fa162ff60b808c3f66ce123c9e22014fb7ce5941486b9d9fda228961c56db
|
|
BLAKE2b-256 checksum How to use checksums |
e531be87e4b4134d7824917c193b72dbbb333831efff1bc3d216e43cefab1fe8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6
|
Security for citationhelper 0.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
