Skip to content

Commit

Permalink
Added requirements.txt
Browse files Browse the repository at this point in the history
- Added requirements.txt
- Updated Classifiers and author information in setup.py
- Added pip install guide to gettingstarted
- Updated READMEs with new doc location
  • Loading branch information
not-na committed Jul 14, 2016
1 parent 9dae4ae commit 16ea31b
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 12 deletions.
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -4,6 +4,6 @@

``fritzctl`` is a fully Object-Oriented Client Library designed to be flexible and future-compatible.

You can install ``fritzctl`` by executing ``python setup.py install`` with the appropriate rights.
You can install ``fritzctl`` by executing ``pip install fritzctl`` with the appropriate rights.

Refer to the documentation located in ``/docs/_build/html/`` for more information and a getting started guide.
Refer to the [documentation](http://fritzctl.rtfd.io) for more information and a getting started guide.
4 changes: 2 additions & 2 deletions README.txt
Expand Up @@ -4,6 +4,6 @@

``fritzctl`` is a fully Object-Oriented Client Library designed to be flexible and future-compatible.

You can install ``fritzctl`` by executing ``python setup.py install`` with the appropriate rights.
You can install ``fritzctl`` by executing ``pip install fritzctl`` with the appropriate rights.

Refer to the documentation located in ``/docs/_build/html/`` for more information and a getting started guide.
Refer to the `documentation <http://fritzctl.rtfd.io/>`_ for more information and a getting started guide.
2 changes: 2 additions & 0 deletions docs/guide/contributing.rst
Expand Up @@ -106,3 +106,5 @@ After you have triple-checked that everything works, you can simply run this com
This command has been tested under Ubuntu 16.04 and will need to be modified to work under windows.

If the process fails during the upload step, simply re-run the command without the register step.

After having released, you should try installing the package on another machine that does not have fritzctl installed, just to see if you missed an added dependency or have another bug that only shows itself on another system.
13 changes: 11 additions & 2 deletions docs/guide/gettingstarted.rst
Expand Up @@ -2,8 +2,17 @@
Getting Started with ``fritzctl``
=================================

Installation
------------
Installation via pip
--------------------

The recommended way of installing ``fritzctl`` is via ``pip``\ ::
$ pip install fritzctl
If you do not have pip installed, you can find how to install it in the `documentation <https://pip.pypa.io/en/stable/installing/>`_\ .

Manual Installation
-------------------

Due to its complexity, ``fritzctl`` needs multiple steps to be installed successfully.

Expand Down
2 changes: 2 additions & 0 deletions requirements.txt
@@ -0,0 +1,2 @@
simpletr64
requests
17 changes: 11 additions & 6 deletions setup.py
Expand Up @@ -49,9 +49,9 @@
version="1.0.0a1",
description="Object oriented TR64 FRITZ!Box Client Library",
long_description=longdesc,
author="AVM",
author_email="Entwicklungssupport@avm.de",
url="https://pypi.python.org/",
author="notna",
author_email="notna@apparat.org",
url="https://pypi.python.org/pypi/fritzctl",
packages=['fritzctl'],
requires=["requests","simpletr64",],
provides=["fritzctl"],
Expand All @@ -64,19 +64,24 @@

"Intended Audience :: Developers",

#"License :: OSI Approved",
#"License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)",
# TODO: clarify license status
"License :: OSI Approved",
"License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)",

"Operating System :: MacOS :: MacOS X",
"Operating System :: Microsoft :: Windows",
"Operating System :: POSIX :: Linux",
"Operating System :: OS Independent",

"Programming Language :: Python",
"Programming Language :: Python :: 2",
"Programming Language :: Python :: 2 :: Only",
"Programming Language :: Python :: 2.6",
"Programming Language :: Python :: 2.7",

"Topic :: Software Development :: Libraries :: Python Modules",
"Topic :: System",
"Topic :: System :: Networking",
"Topic :: System :: Networking :: Monitoring",

],
)

0 comments on commit 16ea31b

Please sign in to comment.