Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
SteveMcGrath committed Oct 12, 2022
1 parent aad0c86 commit 8af2bb4
Show file tree
Hide file tree
Showing 6 changed files with 61 additions and 61 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 ''
Expand Down Expand Up @@ -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
Expand Down
28 changes: 19 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
@@ -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.
40 changes: 22 additions & 18 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 <https://github.com/tenable/integration-cscc>`_
- `Tenable -> BigFix Integration <https://github.com/tenable/integration-bigfix>`_
- `Tenable -> IBM CloudPak for Security Integration <https://github.com/tenable/integrations-ibm-cloudpak-for-security>`_
- `Tenable -> BitDiscovery Integration <???>`_
- `Tenable -> Azure Security Center Integration <https://github.com/tenable/integration-asc>`_
- `Tenable -> JIRA Cloud Integration <https://github.com/tenable/integration-jira-cloud>`_

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 <https://github.com/LetMeR00t/pyCheckpoint-API>`_
- `python-Cybereason <https://github.com/psmiraglia/python-cybereason>`_
- `pyTenable <https://github.com/tenable/pyTenable>`_
- `pyZScaler <https://github.com/mitchos/pyZscaler>`_
- `python-SecurityTrails <https://github.com/SteveMcGrath/python-sectrails-lib>`_
- Various Tenable integrations:
- `Azure Security Center Integration <https://github.com/tenable/integration-asc>`_
- `Google CSCC Integration <https://github.com/tenable/integration-cscc>`_
- `Jira Cloud Integration <https://github.com/tenable/integration-jira-cloud>`_
- `Tenable.asm Asset Importer <https://github.com/tenable/asm-asset-importer>`_

.. _Steve McGrath: https://github.com/stevemcgrath
.. _pyTenable: https://pytenable.readthedocs.io
.. _pyTenable: https://pytenable.readthedocs.io
6 changes: 5 additions & 1 deletion restfly/__init__.py
Original file line number Diff line number Diff line change
@@ -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
4 changes: 3 additions & 1 deletion restfly/version.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
'''
version info
'''
VERSION = '1.4.6'
VERSION = '1.4.7'
AUTHOR = 'Steve McGrath <[email protected]>'
DESCRIPTION = 'REST API library framework'
version_info = tuple(
int(d) for d in VERSION.split("-", maxsplit=1)[0].split(".")
)
36 changes: 4 additions & 32 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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='[email protected]',
url='https://github.com/librestfly/restfly',
license='MIT',
classifiers=[
Expand Down

0 comments on commit 8af2bb4

Please sign in to comment.