Skip to content

Commit f6aecf7

Browse files
pritam001pritam001
committed
Update docs
1 parent a8aa780 commit f6aecf7

File tree

5 files changed

+244
-96
lines changed

5 files changed

+244
-96
lines changed

‎README.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,17 @@ This is a template project hosted on GitHub which can be used to create new repo
3737

3838

3939
### Steps for creating boilerplate project in GitHub
40-
1. Create a new repository named "my-pyflask-project" using this template repository *
40+
1. Create a new repository named "my-pyflask-project" using this template repository *+
4141
1. `git clone https://www.github.com/username/my-pyflask-project.git`
4242
1. `cd my-pyflask-project`
43-
1. Create and activate conda environment `conda activate my-conda-venv` **
43+
1. Create and activate conda environment
44+
`conda init my-conda-venv`
45+
`conda activate my-conda-venv` *^
4446
1. `make setup` : Use pip-tools, pip-compile, pip install to setup python packages
4547

46-
\* [GitHub Guide: Creating a repository from a template](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template)
48+
*+ [GitHub Guide: Creating a repository from a template](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template)
4749
<br>
48-
\** [Guide to Conda environment](https://github.com/pritam001/pyflask-microservice-base/blob/master/documentation/conda.md)
50+
*^ [Guide to Conda environment](https://github.com/pritam001/pyflask-microservice-base/blob/master/documentation/wiki/conda.md)
4951

5052

5153
### Make Guide

‎documentation/wiki/conda.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ https://www.shellhacks.com/python-install-pip-mac-ubuntu-centos/
1313

1414
`export PATH="/usr/local/anaconda3/bin:$PATH"`
1515

16+
`conda init zsh`
17+
1618
##### Create conda virtual env
1719
`conda create -n pyflask-base python=3.8`
1820

‎requirements/dev-requirements.txt‎

Lines changed: 193 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -4,80 +4,199 @@
44
#
55
# pip-compile --output-file=requirements/dev-requirements.txt requirements/dev-requirements.in
66
#
7-
appdirs==1.4.4 # via black, virtualenv
8-
astroid==2.4.2 # via pylint
9-
attrs==19.3.0 # via black, flake8-eradicate, pytest, tbump
10-
autoflake==1.3.1 # via -r requirements/dev-requirements.in
11-
bandit==1.6.2 # via -r requirements/dev-requirements.in
12-
black==19.10b0 # via -r requirements/dev-requirements.in
13-
cfgv==3.2.0 # via pre-commit
14-
cli-ui==0.10.3 # via tbump
15-
click==7.1.2 # via black
16-
colorama==0.4.3 # via cli-ui, radon
17-
contextlib2==0.6.0.post1 # via schema
18-
coverage==5.2.1 # via pytest-cov
19-
distlib==0.3.1 # via virtualenv
20-
docopt==0.6.2 # via tbump
21-
eradicate==1.0 # via flake8-eradicate
22-
filelock==3.0.12 # via virtualenv
23-
flake8-blind-except==0.1.1 # via -r requirements/dev-requirements.in
24-
flake8-breakpoint==1.1.0 # via -r requirements/dev-requirements.in
25-
flake8-builtins==1.5.3 # via -r requirements/dev-requirements.in
26-
flake8-comprehensions==3.2.3 # via -r requirements/dev-requirements.in
27-
flake8-eradicate==0.4.0 # via -r requirements/dev-requirements.in
28-
flake8-flask==0.9.3 # via -r requirements/dev-requirements.in
29-
flake8-logging-format==0.6.0 # via -r requirements/dev-requirements.in
30-
flake8-plugin-utils==1.3.1 # via flake8-breakpoint, flake8-pytest-style, flake8-return
31-
flake8-polyfill==1.0.2 # via pep8-naming, radon
32-
flake8-print==3.1.4 # via -r requirements/dev-requirements.in
33-
flake8-pytest-style==1.2.3 # via -r requirements/dev-requirements.in
34-
flake8-pytest==1.3 # via -r requirements/dev-requirements.in
35-
flake8-return==1.1.2 # via -r requirements/dev-requirements.in
36-
flake8==3.8.3 # via -r requirements/dev-requirements.in, flake8-builtins, flake8-comprehensions, flake8-eradicate, flake8-flask, flake8-polyfill, flake8-print, flake8-pytest
37-
future==0.18.2 # via radon
38-
gitdb==4.0.5 # via gitpython
39-
gitpython==3.1.7 # via bandit
40-
identify==1.4.25 # via pre-commit
41-
iniconfig==1.0.1 # via pytest
42-
isort==4.3.21 # via -r requirements/dev-requirements.in, pylint
43-
lazy-object-proxy==1.4.3 # via astroid
44-
mando==0.6.4 # via radon
45-
mccabe==0.6.1 # via flake8, pylint
46-
more-itertools==8.4.0 # via pytest
47-
mypy-extensions==0.4.3 # via mypy
48-
mypy==0.782 # via -r requirements/dev-requirements.in
49-
nodeenv==1.4.0 # via pre-commit
50-
packaging==20.4 # via pytest
51-
path==13.3.0 # via tbump
52-
pathspec==0.8.0 # via black
53-
pbr==5.4.5 # via stevedore
54-
pep8-naming==0.11.1 # via -r requirements/dev-requirements.in
55-
pluggy==0.13.1 # via pytest
56-
pre-commit==2.6.0 # via -r requirements/dev-requirements.in
57-
py==1.9.0 # via pytest
58-
pycodestyle==2.6.0 # via flake8, flake8-print
59-
pyflakes==2.2.0 # via autoflake, flake8
60-
pylint==2.5.3 # via -r requirements/dev-requirements.in
61-
pyparsing==2.4.7 # via packaging
62-
pytest-cov==2.10.1 # via -r requirements/dev-requirements.in
63-
pytest==6.0.1 # via -r requirements/dev-requirements.in, pytest-cov
64-
pyyaml==5.3.1 # via bandit, pre-commit
65-
r2c-py-ast==0.1.0b1 # via flake8-flask
66-
radon==4.2.0 # via -r requirements/dev-requirements.in
67-
regex==2020.7.14 # via black
68-
schema==0.7.2 # via tbump
69-
six==1.15.0 # via astroid, bandit, flake8-print, mando, packaging, virtualenv
70-
smmap==3.0.4 # via gitdb
71-
stevedore==3.2.0 # via bandit
72-
tabulate==0.8.7 # via cli-ui
73-
tbump==6.1.1 # via -r requirements/dev-requirements.in
74-
toml==0.10.1 # via black, pre-commit, pylint, pytest
75-
tomlkit==0.5.11 # via tbump
76-
typed-ast==1.4.1 # via black, mypy
77-
typing-extensions==3.7.4.2 # via mypy
78-
unidecode==1.1.1 # via cli-ui
79-
virtualenv==20.0.30 # via pre-commit
80-
wrapt==1.12.1 # via astroid
7+
appdirs==1.4.4
8+
# via
9+
# black
10+
# virtualenv
11+
astroid==2.4.2
12+
# via pylint
13+
attrs==19.3.0
14+
# via
15+
# black
16+
# flake8-eradicate
17+
# pytest
18+
# tbump
19+
autoflake==1.3.1
20+
# via -r requirements/dev-requirements.in
21+
bandit==1.6.2
22+
# via -r requirements/dev-requirements.in
23+
black==19.10b0
24+
# via -r requirements/dev-requirements.in
25+
cfgv==3.2.0
26+
# via pre-commit
27+
cli-ui==0.10.3
28+
# via tbump
29+
click==7.1.2
30+
# via black
31+
colorama==0.4.3
32+
# via
33+
# cli-ui
34+
# radon
35+
contextlib2==0.6.0.post1
36+
# via schema
37+
coverage==5.2.1
38+
# via pytest-cov
39+
distlib==0.3.1
40+
# via virtualenv
41+
docopt==0.6.2
42+
# via tbump
43+
eradicate==1.0
44+
# via flake8-eradicate
45+
filelock==3.0.12
46+
# via virtualenv
47+
flake8-blind-except==0.1.1
48+
# via -r requirements/dev-requirements.in
49+
flake8-breakpoint==1.1.0
50+
# via -r requirements/dev-requirements.in
51+
flake8-builtins==1.5.3
52+
# via -r requirements/dev-requirements.in
53+
flake8-comprehensions==3.2.3
54+
# via -r requirements/dev-requirements.in
55+
flake8-eradicate==0.4.0
56+
# via -r requirements/dev-requirements.in
57+
flake8-flask==0.9.3
58+
# via -r requirements/dev-requirements.in
59+
flake8-logging-format==0.6.0
60+
# via -r requirements/dev-requirements.in
61+
flake8-plugin-utils==1.3.1
62+
# via
63+
# flake8-breakpoint
64+
# flake8-pytest-style
65+
# flake8-return
66+
flake8-polyfill==1.0.2
67+
# via
68+
# pep8-naming
69+
# radon
70+
flake8-print==3.1.4
71+
# via -r requirements/dev-requirements.in
72+
flake8-pytest-style==1.2.3
73+
# via -r requirements/dev-requirements.in
74+
flake8-pytest==1.3
75+
# via -r requirements/dev-requirements.in
76+
flake8-return==1.1.2
77+
# via -r requirements/dev-requirements.in
78+
flake8==3.8.3
79+
# via
80+
# -r requirements/dev-requirements.in
81+
# flake8-builtins
82+
# flake8-comprehensions
83+
# flake8-eradicate
84+
# flake8-flask
85+
# flake8-polyfill
86+
# flake8-print
87+
# flake8-pytest
88+
future==0.18.2
89+
# via radon
90+
gitdb==4.0.5
91+
# via gitpython
92+
gitpython==3.1.7
93+
# via bandit
94+
identify==1.4.25
95+
# via pre-commit
96+
iniconfig==1.0.1
97+
# via pytest
98+
isort==4.3.21
99+
# via
100+
# -r requirements/dev-requirements.in
101+
# pylint
102+
lazy-object-proxy==1.4.3
103+
# via astroid
104+
mando==0.6.4
105+
# via radon
106+
mccabe==0.6.1
107+
# via
108+
# flake8
109+
# pylint
110+
more-itertools==8.4.0
111+
# via pytest
112+
mypy-extensions==0.4.3
113+
# via mypy
114+
mypy==0.782
115+
# via -r requirements/dev-requirements.in
116+
nodeenv==1.4.0
117+
# via pre-commit
118+
packaging==20.4
119+
# via pytest
120+
path==13.3.0
121+
# via tbump
122+
pathspec==0.8.0
123+
# via black
124+
pbr==5.4.5
125+
# via stevedore
126+
pep8-naming==0.11.1
127+
# via -r requirements/dev-requirements.in
128+
pluggy==0.13.1
129+
# via pytest
130+
pre-commit==2.6.0
131+
# via -r requirements/dev-requirements.in
132+
py==1.9.0
133+
# via pytest
134+
pycodestyle==2.6.0
135+
# via
136+
# flake8
137+
# flake8-print
138+
pyflakes==2.2.0
139+
# via
140+
# autoflake
141+
# flake8
142+
pylint==2.5.3
143+
# via -r requirements/dev-requirements.in
144+
pyparsing==2.4.7
145+
# via packaging
146+
pytest-cov==2.10.1
147+
# via -r requirements/dev-requirements.in
148+
pytest==6.0.1
149+
# via
150+
# -r requirements/dev-requirements.in
151+
# pytest-cov
152+
pyyaml==5.3.1
153+
# via
154+
# bandit
155+
# pre-commit
156+
r2c-py-ast==0.1.0b1
157+
# via flake8-flask
158+
radon==4.2.0
159+
# via -r requirements/dev-requirements.in
160+
regex==2020.7.14
161+
# via black
162+
schema==0.7.2
163+
# via tbump
164+
six==1.15.0
165+
# via
166+
# astroid
167+
# bandit
168+
# flake8-print
169+
# mando
170+
# packaging
171+
# virtualenv
172+
smmap==3.0.4
173+
# via gitdb
174+
stevedore==3.2.0
175+
# via bandit
176+
tabulate==0.8.7
177+
# via cli-ui
178+
tbump==6.1.1
179+
# via -r requirements/dev-requirements.in
180+
toml==0.10.1
181+
# via
182+
# black
183+
# pre-commit
184+
# pylint
185+
# pytest
186+
tomlkit==0.5.11
187+
# via tbump
188+
typed-ast==1.4.1
189+
# via
190+
# black
191+
# mypy
192+
typing-extensions==3.7.4.2
193+
# via mypy
194+
unidecode==1.1.1
195+
# via cli-ui
196+
virtualenv==20.0.30
197+
# via pre-commit
198+
wrapt==1.12.1
199+
# via astroid
81200

82201
# The following packages are considered to be unsafe in a requirements file:
83202
# setuptools

‎requirements/requirements.txt‎

Lines changed: 40 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,46 @@
44
#
55
# pip-compile --output-file=requirements/requirements.txt requirements/requirements.in
66
#
7-
apispec==3.3.1 # via -r requirements/requirements.in
8-
attrs==19.3.0 # via jsonschema
9-
click==7.1.2 # via flask
10-
dynaconf==3.0.0 # via -r requirements/requirements.in
11-
flasgger==0.9.5 # via -r requirements/requirements.in
12-
flask-cors==3.0.8 # via -r requirements/requirements.in
13-
flask==1.1.2 # via -r requirements/requirements.in, flasgger, flask-cors
14-
itsdangerous==1.1.0 # via flask
15-
jinja2==2.11.2 # via flask
16-
jsonschema==3.2.0 # via flasgger
17-
markupsafe==1.1.1 # via jinja2
18-
marshmallow==3.7.1 # via -r requirements/requirements.in
19-
mistune==0.8.4 # via flasgger
20-
pyrsistent==0.16.0 # via jsonschema
21-
pyyaml==5.3.1 # via flasgger
22-
six==1.15.0 # via flasgger, flask-cors, jsonschema
23-
werkzeug==1.0.1 # via flask
7+
apispec==3.3.1
8+
# via -r requirements/requirements.in
9+
attrs==19.3.0
10+
# via jsonschema
11+
click==7.1.2
12+
# via flask
13+
dynaconf==3.0.0
14+
# via -r requirements/requirements.in
15+
flasgger==0.9.5
16+
# via -r requirements/requirements.in
17+
flask-cors==3.0.8
18+
# via -r requirements/requirements.in
19+
flask==1.1.2
20+
# via
21+
# -r requirements/requirements.in
22+
# flasgger
23+
# flask-cors
24+
itsdangerous==1.1.0
25+
# via flask
26+
jinja2==2.11.2
27+
# via flask
28+
jsonschema==3.2.0
29+
# via flasgger
30+
markupsafe==1.1.1
31+
# via jinja2
32+
marshmallow==3.7.1
33+
# via -r requirements/requirements.in
34+
mistune==0.8.4
35+
# via flasgger
36+
pyrsistent==0.16.0
37+
# via jsonschema
38+
pyyaml==5.3.1
39+
# via flasgger
40+
six==1.15.0
41+
# via
42+
# flasgger
43+
# flask-cors
44+
# jsonschema
45+
werkzeug==1.0.1
46+
# via flask
2447

2548
# The following packages are considered to be unsafe in a requirements file:
2649
# setuptools

‎service_master.py‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,7 @@
99
if __name__ == "__main__":
1010
log.info("Created app instance. Initiating run . . .")
1111
app.run(
12-
host=settings.API.SERVER.url, port=settings.API.SERVER.port, debug=settings.DEBUG,
12+
host=settings.API.SERVER.url,
13+
port=settings.API.SERVER.port,
14+
debug=settings.DEBUG,
1315
)

0 commit comments

Comments
 (0)