pycite 0.1.2

Python Citations Generator

pycite: Python Citations Generator

pycite is a simple to use python citations generator.

Supported Reference Styles

• Harvard

Supported Paper Sources

• NCBI

• Pubmed

• ScienceDirect

• JSTOR

Supported file formats

pycite generates citations given a file of the following types:

• Text files (.txt)

Installation

The simplest way to install the latest release is as follows:

pip install pycite

To install the development version:

Open the Terminal/CMD/Git bash/shell and enter

pip install git+https://github.com/Nelson-Gon/pycite.git

# or for the less stable dev version
pip install git+https://github.com/Nelson-Gon/pycite.git@dev

Otherwise:

# clone the repo
git clone [e-mail]:Nelson-Gon/pycite.git
cd pycite
python3 setup.py install

Usage

Script Mode

To use at the command line, please use:

python -m pycite -i testfiles/testlinks.txt -o testfiles/citations.txt

To get help:

python -m pycite --help
#usage: __main__.py [-h] -i INPUT_FILE -o OUTPUT_FILE
#
#optional arguments:
#  -h, --help            show this help message and exit
#  -i INPUT_FILE, --input-file INPUT_FILE
#                        Path to an input file
#  -o OUTPUT_FILE, --output-file OUTPUT_FILE
#                        Path to an output file

Programming Mode

First, one needs to create an object of class PyCite

from pycite.pycite import PyCite

# Need an input-output file pair 
my_citations = PyCite(input_file="testfiles/testlinks.txt", output_file="testfiles/citations.txt")

To generate citations, one simply calls the cite method.

# This will write citations in the provided output file 
my_citations.cite()

The above gives us (only the first line is shown here). See citations.txt for the full file.

Pohorille A, Wilson MA, & Shannon G (2017)  Flexible Proteins at the Origin of Life Life (Basel), 7(2),  23. 

Notes

This software is provided freely. If you have any concerns, please contact the author. Specifically, the papers used to test that the software works have been randomly chosen. In the event that you notice that any of those papers has been retracted, please immediately inform the author to remove that paper from the tests.

For Science!

To report any issues, suggestions or improvement, please do so at issues.

“Before software can be reusable it first has to be usable.” – Ralph Johnson