Skip to content

Commit

Permalink
Restored requirements and updated doc (#113)
Browse files Browse the repository at this point in the history
* Restored requirements.txt

* Updated README with pipenv
  • Loading branch information
avara1986 committed Jan 28, 2020
1 parent 6f6d955 commit c18aef2
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,34 @@ microservices with Python which handles cross-cutting concerns:

# How to run the scaffold

## Instalation
## Installation

### Install with virtualenv
```bash
virtualenv --python=python[3.6|3.7|3.8] venv
source venv/bin/activate
pip install -r requirements.txt
```

### Install with pipenv
```bash
pip install pipenv
pipenv install
```

#### Advantages over plain pip and requirements.txt
[Pipenv](https://pipenv.readthedocs.io/en/latest/) generates two files: a `Pipfile`and a `Pipfile.lock`.
* `Pipfile`: Is a high level declaration of the dependencies of your project. It can contain "dev" dependencies (usually test related stuff) and "standard" dependencies which are the ones you'll need for your project to function
* `Pipfile.lock`: Is the "list" of all the dependencies your Pipfile has installed, along with their version and their hashes. This prevents two things: Conflicts between dependencies and installing a malicious module.

For a more in-depth explanation please refer to the [official documentation](https://pipenv.readthedocs.io/en/latest/).

## Run your python script
```bash
python manage.py runserver
```


## Check the result

Your default endpoints will be in this url:
Expand Down
6 changes: 6 additions & 0 deletions requirements-tests.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
-r requirements.txt
coveralls==1.10.0
coverage==5.0.2
nose==1.3.7
pylint==2.4.4
tox==3.14.3
6 changes: 6 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Flask-SQLAlchemy==2.4.1
SQLAlchemy==1.3.12
Flask-Script==2.0.6
py-ms==2.1.0
marshmallow==3.3.0
marshmallow-sqlalchemy==0.21.0

0 comments on commit c18aef2

Please sign in to comment.