From bd12fe78e7ce138b7986e9443c9b795465f172de Mon Sep 17 00:00:00 2001 From: dtomlinson Date: Mon, 13 Jan 2020 23:48:19 +0000 Subject: [PATCH] updating documentation --- README.rst | 30 ++++++++++++++++++++++-------- setup.py | 4 ++-- 2 files changed, 24 insertions(+), 10 deletions(-) diff --git a/README.rst b/README.rst index 2487dec..d8a551b 100644 --- a/README.rst +++ b/README.rst @@ -24,23 +24,37 @@ Read the documentation on `read the docs`_. Installation ============== -You can install ..:obj:`panaetius` - -Easy Way -========= +You can install ``panaetius`` the following ways: Python ------- -From pip -~~~~~~~~~ +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 ~~~~~~~~~~~~ -Example Usage -============== +Clone the repo and install using ``setup.py``: +.. code-block:: bash + python setup.py diff --git a/setup.py b/setup.py index 8c99987..921f12b 100644 --- a/setup.py +++ b/setup.py @@ -15,9 +15,9 @@ install_requires = \ setup_kwargs = { '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.', - '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_email': 'dtomlinson@panaetius.co.uk', 'url': 'https://github.com/dtomlinson91/panaetius',