mirror of
https://github.com/dtomlinson91/panaetius.git
synced 2025-12-22 04:55:44 +00:00
adding new README.rst to replace the .md
This commit is contained in:
46
README.rst
Normal file
46
README.rst
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
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 ..:obj:`panaetius`
|
||||||
|
|
||||||
|
Easy Way
|
||||||
|
=========
|
||||||
|
|
||||||
|
Python
|
||||||
|
-------
|
||||||
|
|
||||||
|
From pip
|
||||||
|
~~~~~~~~~
|
||||||
|
|
||||||
|
From local wheel
|
||||||
|
~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
From source
|
||||||
|
~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Example Usage
|
||||||
|
==============
|
||||||
|
|
||||||
@@ -1,10 +1,10 @@
|
|||||||
[tool.poetry]
|
[tool.poetry]
|
||||||
name = "panaetius"
|
name = "panaetius"
|
||||||
version = "1.0.1"
|
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."
|
||||||
license = "MIT"
|
license = "MIT"
|
||||||
authors = ["dtomlinson <dtomlinson@panaetius.co.uk>"]
|
authors = ["dtomlinson <dtomlinson@panaetius.co.uk>"]
|
||||||
readme = "/Users/dtomlinson/git-repos/projects/panaetius/README.md"
|
readme = "/Users/dtomlinson/git-repos/projects/panaetius/README.rst"
|
||||||
homepage = "https://github.com/dtomlinson91/panaetius"
|
homepage = "https://github.com/dtomlinson91/panaetius"
|
||||||
repository = "https://github.com/dtomlinson91/panaetius"
|
repository = "https://github.com/dtomlinson91/panaetius"
|
||||||
documentation = "https://panaetius.readthedocs.io/en/latest/introduction.html"
|
documentation = "https://panaetius.readthedocs.io/en/latest/introduction.html"
|
||||||
|
|||||||
Reference in New Issue
Block a user