From 97b5a526a54615a6b5d6589dc8a81c15c11b36fe Mon Sep 17 00:00:00 2001 From: Bruno <55158870+bruno-canada@users.noreply.github.com> Date: Tue, 28 Dec 2021 13:40:36 -0800 Subject: [PATCH] Adjusted README and related files extension --- AUTHORS => AUTHORS.rst | 2 +- HISTORY => HISTORY.rst | 5 +++++ MANIFEST.in | 6 +++--- README | 21 --------------------- README.rst | 36 ++++++++++++++++++++++++++++++++++++ setup.py | 8 ++++---- 6 files changed, 49 insertions(+), 29 deletions(-) rename AUTHORS => AUTHORS.rst (61%) rename HISTORY => HISTORY.rst (53%) delete mode 100644 README create mode 100644 README.rst diff --git a/AUTHORS b/AUTHORS.rst similarity index 61% rename from AUTHORS rename to AUTHORS.rst index 19ac8ec..1e09396 100644 --- a/AUTHORS +++ b/AUTHORS.rst @@ -10,4 +10,4 @@ Development Lead Contributors ------------ -None yet. Why not be the first? +Looking for engaged developers to make IntegrityGuard an awesome tool. \ No newline at end of file diff --git a/HISTORY b/HISTORY.rst similarity index 53% rename from HISTORY rename to HISTORY.rst index 808c52a..b7586d2 100644 --- a/HISTORY +++ b/HISTORY.rst @@ -2,6 +2,11 @@ History ======= +0.1.1 (2021-12-28) +------------------ + +* Adjusted README file. + 0.1.0 (2021-12-28) ------------------ diff --git a/MANIFEST.in b/MANIFEST.in index c51448f..6dc62a4 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,7 +1,7 @@ -include AUTHORS -include HISTORY +include AUTHORS.rst +include HISTORY.rst include LICENSE -include README +include README.rst recursive-include tests * recursive-exclude * __pycache__ diff --git a/README b/README deleted file mode 100644 index c4a6275..0000000 --- a/README +++ /dev/null @@ -1,21 +0,0 @@ -# IntegrityGuard - -[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md) - -Multiplatform agent for file integrity monitoring (FIM). - -The main motivation for this project is to offer all the minimum features required for a reliable FIM that is independent of any other big monitoring platform. - -IMPORTANT: This project is currently an ALPHA release. Not suitable for production environment, it is still a work in progress. - -# Features highlight - -- Simple and centralized configuration YAML file (`config.yml`) -- Generate logs of any changes in real-time for future auditing -- Push notifications to an API endpoint -- Send email alerts -- Supported hashing methods: "md5", "sha1", "sha224", "sha256", "sha384", "sha512" - -# Call for contributors - - diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..31d0cd3 --- /dev/null +++ b/README.rst @@ -0,0 +1,36 @@ +============== +IntegrityGuard +============== + +.. image:: https://img.shields.io/pypi/v/integrityguard.svg + :target: https://pypi.python.org/pypi/integrityguard + +.. image:: https://pyup.io/repos/github/bruno-canada/integrityguard/shield.svg + :target: https://pyup.io/repos/github/bruno-canada/integrityguard/ + :alt: Updates + +.. image:: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg + :target: code_of_conduct.md + :alt: Contributor Covenant + +Multiplatform agent for file integrity monitoring (FIM). + +The main motivation for this project is to offer all the minimum features required for a reliable FIM that is independent of any other big monitoring platform. + +**IMPORTANT**: This project is currently an ALPHA release. Not suitable for production environment, it is still a work in progress. + +Features highlight +-------------------- + +* Simple and centralized configuration YAML file (``config.yml``) +* Generate logs of any changes in real-time for future auditing +* Push notifications to an API endpoint +* Send email alerts +* Supported hashing methods: "md5", "sha1", "sha224", "sha256", "sha384", "sha512" + +Call for contributors +---------------------- + +This project is just at the begining of its development. We're currently looking for engaged and energized people to colaborate and make it awesome. + + diff --git a/setup.py b/setup.py index 14d77c6..83f88a5 100644 --- a/setup.py +++ b/setup.py @@ -4,10 +4,10 @@ from setuptools import setup, find_packages -with open('README') as readme_file: +with open('README.md') as readme_file: readme = readme_file.read() -with open('HISTORY') as history_file: +with open('HISTORY.md') as history_file: history = history_file.read() requirements = ['Click>=7.0', ] @@ -16,7 +16,7 @@ setup( author="Bruno Bueno", - author_email='bbueno_python@fastmail.com', + author_email='integrityguard@fastmail.com', python_requires='>=3.6', classifiers=[ 'Development Status :: 2 - Pre-Alpha', @@ -44,6 +44,6 @@ test_suite='tests', tests_require=test_requirements, url='https://github.com/bruno-canada/integrityguard', - version='0.1.0', + version='0.1.1', zip_safe=False, )