dtomlinson/panaetius
1
0
Fork 0
mirror of https://github.com/dtomlinson91/panaetius.git synced 2025-12-22 04:55:44 +00:00
Code Issues Projects Releases Wiki Activity

updating documentation

Browse Source
This commit is contained in:
dtomlinson
2020-01-13 23:48:19 +00:00
parent a234b45802
commit bd12fe78e7
2 changed files with 24 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.rst
View File

@@ -24,23 +24,37 @@ Read the documentation on `read the docs`_.
Installation Installation
============== ==============
You can install ..:obj:`panaetius` You can install ``panaetius`` the following ways:
Easy Way
=========
Python Python
------- -------
From pip Install into a virtual environment.
~~~~~~~~~
From pypi using pip
~~~~~~~~~~~~~~~~~~~~
.. code-block:: bash
pip install panaetius
From local wheel 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 From source
~~~~~~~~~~~~ ~~~~~~~~~~~~
Example Usage Clone the repo and install using ``setup.py``:
==============
.. code-block:: bash
python setup.py

4
setup.py
View File

@@ -15,9 +15,9 @@ install_requires = \
setup_kwargs = { setup_kwargs = {
'name': 'panaetius', 'name': 'panaetius',
'version': '1.0', 'version': '1.0.2',
'description': 'Python module to gracefully handle a .config file/environment variables for scripts, with built in masking for sensitive options. Provides a Splunk friendly logger instance.', 'description': 'Python module to gracefully handle a .config file/environment variables for scripts, with built in masking for sensitive options. Provides a Splunk friendly logger instance.',
'long_description': '# Author\n\nDaniel Tomlinson (dtomlinson@panaetius.co.uk)\n\n# Requires\n\n`>= python3.7`\n\n# Python requirements\n\n- toml = "^0.10.0"\n- pylite = "^0.1.0"\n\n# Documentation\n\n_soon_\n\n# Installation\n\n_soon_\n\n# Easy Way\n\n## Python\n\n### From pip\n\n### From local wheel\n\n### From source\n\n# Example Usage\n\n', 'long_description': 'Author\n=======\n\nDaniel Tomlinson (dtomlinson@panaetius.co.uk)\n\nRequires\n=========\n\n`>= python3.7`\n\nPython requirements\n====================\n\n- toml = "^0.10.0"\n- pylite = "^0.1.0"\n\nDocumentation\n==============\n\nRead the documentation on `read the docs`_.\n\n.. _read the docs: https://panaetius.readthedocs.io/en/latest/introduction.html\n\nInstallation\n==============\n\nYou can install ..:obj:`panaetius`\n\nEasy Way\n=========\n\nPython\n-------\n\nFrom pip\n~~~~~~~~~\n\nFrom local wheel\n~~~~~~~~~~~~~~~~~\n\nFrom source\n~~~~~~~~~~~~\n\nExample Usage\n==============\n\n',
'author': 'dtomlinson', 'author': 'dtomlinson',
'author_email': 'dtomlinson@panaetius.co.uk', 'author_email': 'dtomlinson@panaetius.co.uk',
'url': 'https://github.com/dtomlinson91/panaetius', 'url': 'https://github.com/dtomlinson91/panaetius',