Skip to content

Commit

Permalink
Updated documentation and repointed links to new repo location (#9)
Browse files Browse the repository at this point in the history
  • Loading branch information
SteveMcGrath authored Oct 12, 2022
1 parent a9216db commit aad0c86
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 16 deletions.
12 changes: 7 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,16 @@ RESTfly

.. image:: docs/_static/logo.png

.. image:: https://github.com/SteveMcGrath/restfly/actions/workflows/pipeline.yml/badge.svg
:target: https://github.com/SteveMcGrath/restfly/actions/workflows/pipeline.yml
.. 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://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
.. image:: https://img.shields.io/github/license/stevemcgrath/restfly.svg
.. image:: https://img.shields.io/github/license/librestfly/restfly.svg
:target: https://github.com/librestfly/restfly/blob/master/LICENSE

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 documentation at https://restfly.readthedocs.io
27 changes: 16 additions & 11 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
'''
RESTfly Package
'''
from setuptools import setup, find_packages

with open('restfly/version.py', 'r') as vfile:
exec(vfile.read())
with open('restfly/version.py', 'r') as vfile: # noqa PLW1514
exec(vfile.read()) # noqa PLW0122

long_description = '''
RESTfly: Simplifying API Libraries
Expand All @@ -10,14 +13,16 @@
**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
.. image:: https://img.shields.io/pypi/dm/restfly.svg
.. image:: https://img.shields.io/github/license/stevemcgrath/restfly.svg
:target: https://github.com/SteveMcGrath/restfly/blob/master/LICENSE
.. 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
Expand All @@ -26,19 +31,19 @@
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 implimentation of the given APIs.
can also serve as a reference implementation of the given APIs.
Please refer to the full documentation at https://restfly.readthedocs.io.
'''
''' # noqa E501

setup(
name='restfly',
version=VERSION, # noqa: F821
version=VERSION, # noqa: F821,PLE0602
description='A library to make API wrappers creation easier',
author='Steve McGrath',
long_description=long_description,
author_email='[email protected]',
url='https://github.com/stevemcgrath/restfly',
url='https://github.com/librestfly/restfly',
license='MIT',
classifiers=[
'Development Status :: 5 - Production/Stable',
Expand All @@ -53,7 +58,7 @@
'Programming Language :: Python :: 3.9',
'Programming Language :: Python :: 3.10',
],
keywords='tenable tenable_io securitycenter containersecurity',
keywords='rest api library',
packages=find_packages(exclude=['docs', 'tests']),
install_requires=[
'requests>=2.26.0',
Expand Down

0 comments on commit aad0c86

Please sign in to comment.