Add Readme; bump to 0.2.0a2

This commit is contained in:
Xavier Bustamante Talavera 2018-06-10 19:58:27 +02:00
parent b9f989270d
commit df169c1be3
2 changed files with 63 additions and 11 deletions

52
README.md Normal file
View File

@ -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.

View File

@ -1,18 +1,18 @@
from setuptools import find_packages, setup from setuptools import find_packages, setup
setup( setup(
name="eReuse_Devicehub", name="ereuse-devicehub",
version='0.0.1', version='0.2.0a2',
packages=find_packages(), packages=find_packages(),
url='https://github.com/ereuse/devicehub-teal', url='https://github.com/ereuse/devicehub-teal',
license='Affero', license='Affero',
author='eReuse.org team', author='eReuse.org team',
author_email='x.bustamante@ereuse.org', 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=[ install_requires=[
'teal', 'teal',
'marshmallow_enum', 'marshmallow_enum',
'ereuse-utils [Naming]', 'ereuse-utils [Naming] >= 0.3.0b1',
'psycopg2-binary', 'psycopg2-binary',
'sqlalchemy-utils', 'sqlalchemy-utils',
'requests', 'requests',
@ -24,15 +24,15 @@ setup(
'pytest-datadir', 'pytest-datadir',
'requests_mock' 'requests_mock'
], ],
classifiers={ classifiers=[
'Development Status :: 4 - Beta', 'Development Status :: 2 - Pre-Alpha',
'Environment :: Web Environment', 'Environment :: Web Environment',
'Intended Audience :: Developers', 'Intended Audience :: Developers',
'License :: OSI Approved :: BSD License',
'Operating System :: OS Independent', 'Operating System :: OS Independent',
'Programming Language :: Python', 'Programming Language :: Python :: 3 :: Only',
'Programming Language :: Python :: 3.5', 'Programming Language :: Python :: 3.5',
'Topic :: Internet :: WWW/HTTP :: Dynamic Content', 'Topic :: Internet :: WWW/HTTP :: HTTP Servers',
'Topic :: Software Development :: Libraries :: Python Modules' 'Topic :: Software Development :: Libraries :: Python Modules',
}, 'License :: OSI Approved :: GNU Affero General Public License v3'
],
) )