diff --git a/README.md b/README.md index c709aafc..586d9dbf 100644 --- a/README.md +++ b/README.md @@ -21,9 +21,9 @@ Devicehub is built with [Teal](https://github.com/bustawin/teal) and ## Installing The requirements are: -- Python 3.5.3 or higher. In debian is `# apt install python3-pip`. -- PostgreSQL 9.6 or higher. In debian is `# apt install postgresql` -- passlib. In debian is `# apt install python3-passlib`. +- Python 3.5.3 or higher. In debian 9 is `# apt install python3-pip`. +- PostgreSQL 9.6 or higher. In debian 9 is `# apt install postgresql` +- passlib. In debian 9 is `# apt install python3-passlib`. Install Devicehub with *pip*: `pip3 install ereuse-devicehub -U --pre`. @@ -42,11 +42,13 @@ app = Devicehub(MyConfig()) Create a PostgreSQL database called *devicehub*: ```bash -# su - postgres -postgres $ createdb devicehub -postgres $ psql devicehub -postgres $ GRANT ALL PRIVILEGES ON DATABASE devicehub TO dhub; +sudo su - postgres # Change to Postgres main user +postgres $ createdb devicehub # Create main database +postgres $ psql devicehub # Access to the database +postgres $ CREATE USER dhub WITH PASSWORD 'ereuse'; # Create user devicehub uses to access db +postgres $ GRANT ALL PRIVILEGES ON DATABASE devicehub TO dhub; # Give access to the db postgres $ \q +exit ``` Create the tables in the database by executing in the same directory @@ -62,6 +64,9 @@ Finally, run the app: $ flask run ``` +The error `flask: command not found` can happen when you are not in a +*virtual environment*. Try executing then `python3 -m flask`. + See the [Flask quickstart](http://flask.pocoo.org/docs/1.0/quickstart/) for more info. diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index 224a7795..00000000 --- a/setup.cfg +++ /dev/null @@ -1,2 +0,0 @@ -[metadata] -description-file = README.md \ No newline at end of file diff --git a/setup.py b/setup.py index bae74141..d7d314ce 100644 --- a/setup.py +++ b/setup.py @@ -1,8 +1,11 @@ from setuptools import find_packages, setup +with open('README.md') as f: + long_description = f.read() + setup( - name="ereuse-devicehub", - version='0.2.0a6', + name='ereuse-devicehub', + version='0.2.0a7', packages=find_packages(), url='https://github.com/ereuse/devicehub-teal', license='Affero', @@ -10,20 +13,19 @@ setup( author_email='x.bustamante@ereuse.org', include_package_data=True, description='A system to manage devices focusing reuse.', + long_description=long_description, + long_description_content_type='text/markdown', install_requires=[ - 'teal>=0.2.0a2', + 'teal>=0.2.0a4', 'marshmallow_enum', - 'ereuse-utils [Naming]>=0.3.0b2', + 'ereuse-utils[Naming]>=0.3.0b2', 'psycopg2-binary', 'requests', 'requests-toolbelt', 'hashids', 'tqdm', 'click-spinner', - 'sqlalchemy-utils', - 'sqlalchemy-utils [password]', - 'sqlalchemy-utils [color]', - 'sqlalchemy-utils [babel]', + 'sqlalchemy-utils[password, color, babel]', 'PyYAML' ], tests_requires=[