One-line description here!

My Python Library

This is a template for creating new python library. Here are some descriptions!

features

• print Hello World!
• print many Hello Worlds!
• command line tools for printing a lot of Hello Worlds!

Documentation: https://mypythonlibrary.readthedocs.io

Repository: https://github.com/terrencetec/mypythonlibrary

Contents

• My Python Library
• Getting Started
  • Dependencies
  • Install from source
• How to Contribute
• For Developers
  • Standards and Tools
  • Cheat sheet

Getting Started

Dependencies

Required

• Package 1
• Package 2
• Package 3

Optional

• Package 4

Note on installing dependencies

In principle, if you are using pip, you don't have to install dependencies beforehand. When you install this package, :code`pip` will automatically install the required libraries. However if you are using Conda it is best to use its own package manager and not pip unless absolutely necessary.

If you use conda:

conda install -c conda-forge package1 package2

Now, let's say package 3 is not available, then we can use pip. But, be sure to use which pip to check if we are using the pip installed on the conda environment and not the global one.

pip install package3

Install from source

git clone https://github.com/terrencetec/mypythonlibrary.git
cd mypythonlibrary
pip install .

How to Contribute

Try out the package and file an issue if you find any!

For Developers

Standards and Tools

Please comply with the following standards/guides as much as possible.

Coding style

• PEP 8: https://www.python.org/dev/peps/pep-0008/

CHANGELOG

• Keep a Changelog: https://keepachangelog.com/en/1.0.0/

Versioning

• Semantic Versioning: https://semver.org/spec/v2.0.0.html

Packaging

• PyPA: https://www.pypa.io
• python-packaging: https://python-packaging.readthedocs.io

Documentation

• NumPy docstrings: https://numpydoc.readthedocs.io/en/latest/format.html
• Sphinx: https://www.sphinx-doc.org/
• Read The Docs: https://readthedocs.org/
• Documenting Python Code: A Complete Guide: https://realpython.com/documenting-python-code/

Cheat sheet

Sphinx

Generate documentation base, in docs/,

sphinx-quickstart

Select separate build and source files when prompted.

Preview documentation page with modified source, in docs/

make html

Open index.html with a browser (if this was set as the first page).