Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,16 @@ Barebones Python Microservices
[![Python 3](https://pyup.io/repos/github/python-microservices/microservices-scaffold/python-3-shield.svg)](https://pyup.io/repos/github/python-microservices/microservices-scaffold/)


# How to run the scaffold

```bash
python manage.py runserver

```

Open in your browser http://localhost:5000/template/ui/

Read more info in the documentation page: https://microservices-scaffold.readthedocs.io/en/latest/

# Docker

Expand Down
1 change: 1 addition & 0 deletions docs/codeexample.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
Code Examples
=============

See simple examples in https://github.com/python-microservices/pyms/tree/master/examples
15 changes: 15 additions & 0 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,22 @@
Quickstart
==========

Scaffold
--------

Clone and start this scaffold

.. code-block:: bash
git clone https://github.com/python-microservices/microservices-scaffold.git
cd microservices-scaffold
python manage.py runserver


Open in your browser http://localhost:8080/template/ui/

Template
--------

You can create your own project from template:

https://github.com/python-microservices/microservices-template
3 changes: 2 additions & 1 deletion docs/structure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ You have a project with this structure:
Dockerfile
LICENSE
manage.py
config.yml
README.md
requirements.txt
requirements-tests.txt
Expand All @@ -18,7 +19,6 @@ You have a project with this structure:
tox.ini
project
├ __init__.py
├ config.py
├ models
│ ├ __init__.py
│ └ models.py
Expand Down Expand Up @@ -48,6 +48,7 @@ You can set the host and the port with:

python manage.py runserver -h 0.0.0.0 -p 8080


Common Libraries
----------------

Expand Down
2 changes: 1 addition & 1 deletion project/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
__author__ = "Alberto Vara"
__email__ = "[email protected]"
__version__ = "0.3.1"
__version__ = "1.0.0"
3 changes: 1 addition & 2 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Flask-SQLAlchemy==2.3.2
SQLAlchemy==1.2.16
Flask-Script==2.0.6
# py-ms==0.1.1
git+https://github.com/python-microservices/pyms.git@master#egg=py-ms
py-ms==1.0.0