Skip to main content

Python Citations Generator

Project description

pycite: Python Citations Generator

DOI PyPI version fury.io Project Status Codecov Test-Package Build Status PyPI license Documentation Status Total Downloads Monthly Downloads Weekly Downloads Maintenance GitHub last commit GitHub issues GitHub issues-closed

pycite is a simple to use python citations generator.

Supported Reference Styles

  • Harvard

Supported Paper Sources

  • NCBI

  • Pubmed

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 git@github.com:Nelson-Gon/pycite.git
cd pycite
python3 setup.py install

Usage

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 Flexible Proteins at the Origin of Life (2017) Life (Basel), 7(2)

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pycite-0.1.1.tar.gz (6.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pycite-0.1.1-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file pycite-0.1.1.tar.gz.

File metadata

  • Download URL: pycite-0.1.1.tar.gz
  • Upload date:
  • Size: 6.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.10

File hashes

Hashes for pycite-0.1.1.tar.gz
Algorithm Hash digest
SHA256 cdd0bec097d5b0a2f30f1169d053669cc6bff7f3272c1c4d6c7873ab8a26f9ba
MD5 4ad90ee692d3c465150eaf5621a88bf7
BLAKE2b-256 3faad8ecee105c407d21e68837f09dde8e616c0f372842673116c02e94dfe4bf

See more details on using hashes here.

File details

Details for the file pycite-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: pycite-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.10

File hashes

Hashes for pycite-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 db2a9e6b684b93fe9c333a91b71176ba57bb9a3598c89165e642beac86c9b640
MD5 54d4692dd1b1d9929264efc1325f61d8
BLAKE2b-256 bd5b389fc02a3b88c358cf5cc399d2a24308e09ac1eb0201895c541cfca5b234

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page