mirror of
https://github.com/dtomlinson91/panaetius.git
synced 2025-12-22 04:55:44 +00:00
updating latest version with up to date documentation
This commit is contained in:
61
README.rst
Normal file
61
README.rst
Normal file
@@ -0,0 +1,61 @@
|
||||
Author
|
||||
=======
|
||||
|
||||
Daniel Tomlinson (dtomlinson@panaetius.co.uk)
|
||||
|
||||
Requires
|
||||
=========
|
||||
|
||||
`>= python3.7`
|
||||
|
||||
Python requirements
|
||||
====================
|
||||
|
||||
- toml = "^0.10.0"
|
||||
- pylite = "^0.1.0"
|
||||
|
||||
Documentation
|
||||
==============
|
||||
|
||||
Read the documentation on `read the docs`_.
|
||||
|
||||
.. _read the docs: https://panaetius.readthedocs.io/en/latest/introduction.html
|
||||
|
||||
Installation
|
||||
==============
|
||||
|
||||
You can install ``panaetius`` the following ways:
|
||||
|
||||
Python
|
||||
-------
|
||||
|
||||
Install into a virtual environment.
|
||||
|
||||
From pypi using pip
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pip install panaetius
|
||||
|
||||
From local wheel
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
Download the latest verion from the `releases`_ page.
|
||||
|
||||
.. _releases: https://github.com/dtomlinson91/panaetius/releases
|
||||
|
||||
Install with pip:
|
||||
|
||||
.. code-block:: bash
|
||||
pip install -U panaetius-1.0.2-py3-none-any.whl
|
||||
|
||||
|
||||
From source
|
||||
~~~~~~~~~~~~
|
||||
|
||||
Clone the repo and install using ``setup.py``:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
python setup.py
|
||||
Reference in New Issue
Block a user