citebang 0.1.0

open-source tool used for academic literature searches

‘citebang’ is an open-source tool used for academic literature searches.

Installation

Users

All stable releases of this project are available through PyPi. To install this project via pip, use the following command:

$ python3 -m pip install –upgrade citebang

To check whether or not the package was installed, try the following command:

$ python3 -c “import citebang”

Installing the package this way will also add the ‘citebang’ CLI command:

$ citebang –help

Developers

If you would like to contribute to this project, it is recommended that you clone this repository and install all its dependencies and developer tools. An easy-to-use makefile is provided to make this process fast and easy.

1. clone this git repository
2. run make install to install a local virtual environment, all dependencies, and used developer tools
3. run make help for more information
4. done

Note that ‘make install’ does not touch your global installation. All changes are local, and thus removing the cloned repository’s directory also cleans up the project.

Tests

To run all tests, simply use the command:

$ make test

License

This project is licensed under the MIT License.