diff --git a/README.md b/README.md new file mode 100644 index 00000000..11a61997 --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +# Devicehub + +Devicehub is an IT Asset Management System focused in reusing devices, +created under the project [eReuse.org](https://www.ereuse.org). + +Our main objectives are: + +- To offer a common IT Asset Management for donors, receivers and IT + professionals so they can manage devices and exchange them. + This is, reusing –and ultimately recycling. +- To automatically recollect, analyse, process and share + (controlling privacy) metadata about devices with other tools of the + eReuse ecosystem to guarantee traceability, and to provide inputs for + the indicators which measure circularity. +- To highly integrate with existing IT Asset Management Systems. +- To be decentralized. + +Devicehub is built with [Teal](https://github.com/bustawin/teal) and +[Flask](http://flask.pocoo.org). + +## Installation +The requirements are: + +- Python 3.5 or higher. +- PostgreSQL 9.6 or higher. + +Install Devicehub with *pip*: `pip3 install ereuse-devicehub`. + +## Running +To use it create a python file with the following and call it `app.py`: +```python +from ereuse_devicehub.devicehub import Devicehub +from ereuse_devicehub.config import DevicehubConfig +class MyConfig(DevicehubConfig): + ORGANIZATION_NAME = 'My org' + ORGANIZATION_TAX_ID = 'foo-bar' + + +app = Devicehub(MyConfig()) +``` +Crate a PostgreSQL database: +```bash +$ createdb dh-db1 +``` + +And then execute, in the same directory where `app.py` is: +```bash +$ flask run +``` + +See the [Flask quickstart](http://flask.pocoo.org/docs/1.0/quickstart/) +for more info. \ No newline at end of file diff --git a/setup.py b/setup.py index 8bce8928..575ab370 100644 --- a/setup.py +++ b/setup.py @@ -1,18 +1,18 @@ from setuptools import find_packages, setup setup( - name="eReuse_Devicehub", - version='0.0.1', + name="ereuse-devicehub", + version='0.2.0a2', packages=find_packages(), url='https://github.com/ereuse/devicehub-teal', license='Affero', author='eReuse.org team', author_email='x.bustamante@ereuse.org', - description='A system to manage devices focused in reusing them.', + description='A system to manage devices focusing reuse.', install_requires=[ 'teal', 'marshmallow_enum', - 'ereuse-utils [Naming]', + 'ereuse-utils [Naming] >= 0.3.0b1', 'psycopg2-binary', 'sqlalchemy-utils', 'requests', @@ -24,15 +24,15 @@ setup( 'pytest-datadir', 'requests_mock' ], - classifiers={ - 'Development Status :: 4 - Beta', + classifiers=[ + 'Development Status :: 2 - Pre-Alpha', 'Environment :: Web Environment', 'Intended Audience :: Developers', - 'License :: OSI Approved :: BSD License', 'Operating System :: OS Independent', - 'Programming Language :: Python', + 'Programming Language :: Python :: 3 :: Only', 'Programming Language :: Python :: 3.5', - 'Topic :: Internet :: WWW/HTTP :: Dynamic Content', - 'Topic :: Software Development :: Libraries :: Python Modules' - }, + 'Topic :: Internet :: WWW/HTTP :: HTTP Servers', + 'Topic :: Software Development :: Libraries :: Python Modules', + 'License :: OSI Approved :: GNU Affero General Public License v3' + ], )