From 8af2bb4d2eac82f8aa7570ca1c4ef963044a9620 Mon Sep 17 00:00:00 2001 From: Steve McGrath Date: Wed, 12 Oct 2022 14:41:58 -0500 Subject: [PATCH] Updated documentation --- CHANGELOG.md | 8 ++++++++ README.rst | 28 +++++++++++++++++++--------- docs/index.rst | 40 ++++++++++++++++++++++------------------ restfly/__init__.py | 6 +++++- restfly/version.py | 4 +++- setup.py | 36 ++++-------------------------------- 6 files changed, 61 insertions(+), 61 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 028e9e0..fa97321 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [1.4.7] +### Fixed +- check method UnknownError exception message was malformed #10 + +### Changed +- Updated documentation to point to new library location. + ## [1.4.6] ### Fixed - default base_path was set to None instead of '' @@ -145,6 +152,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Initial Version +[1.4.7]: https://github.com/SteveMcGrath/restfly/compare/1.4.6...1.4.7 [1.4.6]: https://github.com/SteveMcGrath/restfly/compare/1.4.5...1.4.6 [1.4.5]: https://github.com/SteveMcGrath/restfly/compare/1.4.4...1.4.5 [1.4.4]: https://github.com/SteveMcGrath/restfly/compare/1.4.3...1.4.4 diff --git a/README.rst b/README.rst index 7cdcefd..c445c22 100644 --- a/README.rst +++ b/README.rst @@ -1,18 +1,28 @@ -RESTfly -======= +RESTfly: Simplifying API Libraries +================================== -.. image:: docs/_static/logo.png +**RESTfly** (pronounced restfully) is a framework for building libraries to +easily interact with RESTful APIs. -.. image:: https://github.com/librestfly/restfly/actions/workflows/testing.yml/badge.svg - :target: https://github.com/librestfly/restfly/actions/workflows/testing.yml -.. image:: https://sonarcloud.io/api/project_badges/measure?project=librestfly_restfly&metric=alert_status - :target: https://sonarcloud.io/summary/overall?id=librestfly_restfly +.. image:: https://travis-ci.org/librestfly/restfly.svg?branch=master + :target: https://travis-ci.org/librestfly/restfly .. image:: https://img.shields.io/pypi/v/restfly.svg :target: https://pypi.org/project/restfly/ .. image:: https://img.shields.io/pypi/pyversions/restfly.svg .. image:: https://img.shields.io/pypi/dm/restfly.svg + :target: https://pypistats.org/packages/restfly .. image:: https://img.shields.io/github/license/librestfly/restfly.svg :target: https://github.com/librestfly/restfly/blob/master/LICENSE +.. image:: https://sonarcloud.io/api/project_badges/measure?project=librestfly_restfly&metric=alert_status + :target: https://sonarcloud.io/summary/overall?id=librestfly_restfly + + +.. image:: https://restfly.readthedocs.io/en/latest/_static/logo.png + +RESTfly is a simple library designed to provide the scaffolding to make API +interaction libraries for just about any RESTful API. With an emphasis on +simplicity and readability of the resulting library code thats written, the +idea here is provide something that is not only useful for folks to use, but +can also serve as a reference implementation of the given APIs. -A simple framework for building RESTful API libraries. for more information, -please refer to the documentation at https://restfly.readthedocs.io +Please refer to the full documentation at https://restfly.readthedocs.io. diff --git a/docs/index.rst b/docs/index.rst index bbd59fe..0c43e1d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,16 +6,17 @@ Release v\ |version|. **RESTfly** (pronounced restfully) is a framework for building libraries to easily interact with RESTful APIs. -.. image:: https://travis-ci.org/SteveMcGrath/restfly.svg?branch=master - :target: https://travis-ci.org/SteveMcGrath/restfly +.. image:: https://travis-ci.org/librestfly/restfly.svg?branch=master + :target: https://travis-ci.org/librestfly/restfly .. image:: https://img.shields.io/pypi/v/restfly.svg :target: https://pypi.org/project/restfly/ .. image:: https://img.shields.io/pypi/pyversions/restfly.svg - :target: https://pypi.org/project/restfly/ .. image:: https://img.shields.io/pypi/dm/restfly.svg - :target: https://github.com/stevemcgrath/restfly -.. image:: https://img.shields.io/github/license/stevemcgrath/restfly.svg - :target: https://github.com/stevemcgrath/restfly + :target: https://pypistats.org/packages/restfly +.. image:: https://img.shields.io/github/license/librestfly/restfly.svg + :target: https://github.com/librestfly/restfly/blob/master/LICENSE +.. image:: https://sonarcloud.io/api/project_badges/measure?project=librestfly_restfly&metric=alert_status + :target: https://sonarcloud.io/summary/overall?id=librestfly_restfly .. image:: https://live.staticflickr.com/2815/10007461563_a02f26528f_c.jpg @@ -54,17 +55,20 @@ this part of the documentation is what you're looking for. Libraries Using RESTfly ----------------------- -RESTfly is a fairly new library based on the work of `Steve McGrath`_ within the -pyTenable_ project. There are several other projects also leveraging RESTfly -listed below: - -- `Tenable -> Google Security Command Center Integration `_ -- `Tenable -> BigFix Integration `_ -- `Tenable -> IBM CloudPak for Security Integration `_ -- `Tenable -> BitDiscovery Integration `_ -- `Tenable -> Azure Security Center Integration `_ -- `Tenable -> JIRA Cloud Integration `_ - +RESTfly is a fairly new library based on the work of `Steve McGrath`_ within +the pyTenable project. There are several other projects also leveraging +RESTfly listed below: + +- `pyCheckpoint-API `_ +- `python-Cybereason `_ +- `pyTenable `_ +- `pyZScaler `_ +- `python-SecurityTrails `_ +- Various Tenable integrations: + - `Azure Security Center Integration `_ + - `Google CSCC Integration `_ + - `Jira Cloud Integration `_ + - `Tenable.asm Asset Importer `_ .. _Steve McGrath: https://github.com/stevemcgrath -.. _pyTenable: https://pytenable.readthedocs.io \ No newline at end of file +.. _pyTenable: https://pytenable.readthedocs.io diff --git a/restfly/__init__.py b/restfly/__init__.py index dc23d28..6aeb2b9 100644 --- a/restfly/__init__.py +++ b/restfly/__init__.py @@ -1,7 +1,11 @@ ''' RESTfly package ''' -from .version import VERSION as __version__ # noqa: F401 +from .version import ( # noqa: F401 + VERSION as __version__, + AUTHOR as __author__, + DESCRIPTION as __description__ +) from .session import APISession # noqa: F401 from .endpoint import APIEndpoint # noqa: F401 from .iterator import APIIterator # noqa: F401 diff --git a/restfly/version.py b/restfly/version.py index dcba276..0a5c93f 100644 --- a/restfly/version.py +++ b/restfly/version.py @@ -1,7 +1,9 @@ ''' version info ''' -VERSION = '1.4.6' +VERSION = '1.4.7' +AUTHOR = 'Steve McGrath ' +DESCRIPTION = 'REST API library framework' version_info = tuple( int(d) for d in VERSION.split("-", maxsplit=1)[0].split(".") ) diff --git a/setup.py b/setup.py index d020833..62ec446 100644 --- a/setup.py +++ b/setup.py @@ -6,43 +6,15 @@ with open('restfly/version.py', 'r') as vfile: # noqa PLW1514 exec(vfile.read()) # noqa PLW0122 -long_description = ''' -RESTfly: Simplifying API Libraries -================================== - -**RESTfly** (pronounced restfully) is a framework for building libraries to -easily interact with RESTful APIs. - -.. image:: https://travis-ci.org/librestfly/restfly.svg?branch=master - :target: https://travis-ci.org/librestfly/restfly -.. image:: https://img.shields.io/pypi/v/restfly.svg - :target: https://pypi.org/project/restfly/ -.. image:: https://img.shields.io/pypi/pyversions/restfly.svg -.. image:: https://img.shields.io/pypi/dm/restfly.svg -.. image:: https://img.shields.io/github/license/librestfly/restfly.svg - :target: https://github.com/librestfly/restfly/blob/master/LICENSE -.. image:: https://sonarcloud.io/api/project_badges/measure?project=librestfly_restfly&metric=alert_status - :target: https://sonarcloud.io/summary/overall?id=librestfly_restfly - - -.. image:: https://restfly.readthedocs.io/en/latest/_static/logo.png - -RESTfly is a simple library designed to provide the scaffolding to make API -interaction libraries for just about any RESTful API. With an emphasis on -simplicity and readability of the resulting library code thats written, the -idea here is provide something that is not only useful for folks to use, but -can also serve as a reference implementation of the given APIs. - -Please refer to the full documentation at https://restfly.readthedocs.io. -''' # noqa E501 +with open('README.rst', 'r') as ldfile: # noqa PLW1514 + long_description = ldfile.read() setup( name='restfly', version=VERSION, # noqa: F821,PLE0602 - description='A library to make API wrappers creation easier', - author='Steve McGrath', + description=DESCRIPTION, # noqa: F821,PLE0602 + author=AUTHOR, # noqa: F821,PLE0602 long_description=long_description, - author_email='steve@chigeek.com', url='https://github.com/librestfly/restfly', license='MIT', classifiers=[