diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..670c2bb --- /dev/null +++ b/.gitignore @@ -0,0 +1,130 @@ +# Taken from https://raw.githubusercontent.com/github/gitignore/master/Python.gitignore +# Many thanks to the people who wrote this! + +# VSCode settings +.vscode + +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +pip-wheel-metadata/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +.python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# celery beat schedule file +celerybeat-schedule + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 0000000..e52dc56 --- /dev/null +++ b/.pylintrc @@ -0,0 +1,110 @@ +[MASTER] +persistent=no +load-plugins= +jobs=1 +unsafe-load-any-extension=no +extension-pkg-whitelist= + +[MESSAGES CONTROL] +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED +confidence= +disable= + attribute-defined-outside-init, + duplicate-code, + fixme, + invalid-name, + missing-docstring, + protected-access, + too-few-public-methods, + # handled by black + format + +[REPORTS] +output-format=colorized +files-output=no +reports=no +evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) + +[LOGGING] +logging-modules=logging + +[MISCELLANEOUS] +notes=FIXME,XXX,TODO + +[SIMILARITIES] +min-similarity-lines=4 +ignore-comments=yes +ignore-docstrings=yes +ignore-imports=no + +[VARIABLES] +init-import=no +dummy-variables-rgx=_$|dummy +additional-builtins= +callbacks=cb_,_cb + +[FORMAT] +max-line-length=100 +ignore-long-lines=^\s*(# )??$ +single-line-if-stmt=no +no-space-check=trailing-comma,dict-separator +max-module-lines=2000 +indent-string=' ' +indent-after-paren=4 +expected-line-ending-format= + +[BASIC] +bad-functions=map,filter,input +good-names=i,j,k,ex,Run,_ +bad-names=foo,bar,baz,toto,tutu,tata +name-group= +include-naming-hint=yes +function-rgx=[a-z_][a-z0-9_]{2,30}$ +function-name-hint=[a-z_][a-z0-9_]{2,30}$ +variable-rgx=[a-z_][a-z0-9_]{2,30}$ +variable-name-hint=[a-z_][a-z0-9_]{2,30}$ +const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ +const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ +attr-rgx=[a-z_][a-z0-9_]{2,}$ +attr-name-hint=[a-z_][a-z0-9_]{2,}$ +argument-rgx=[a-z_][a-z0-9_]{2,30}$ +argument-name-hint=[a-z_][a-z0-9_]{2,30}$ +class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ +class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ +inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ +inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ +class-rgx=[A-Z_][a-zA-Z0-9]+$ +class-name-hint=[A-Z_][a-zA-Z0-9]+$ +module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ +module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ +method-rgx=[a-z_][a-z0-9_]{2,}$ +method-name-hint=[a-z_][a-z0-9_]{2,}$ +no-docstring-rgx=__.*__ +docstring-min-length=-1 +property-classes=abc.abstractproperty + +[TYPECHECK] +ignore-mixin-members=yes +ignored-modules= +ignored-classes=SQLObject, optparse.Values, thread._local, _thread._local +generated-members=REQUEST,acl_users,aq_parent +contextmanager-decorators=contextlib.contextmanager + +[DESIGN] +max-args=8 +ignored-argument-names=_.* +max-locals=25 +max-returns=11 +max-branches=26 +max-statements=100 +max-parents=7 +max-attributes=11 +min-public-methods=2 +max-public-methods=25 + +[CLASSES] +defining-attr-methods=__init__,__new__,setUp +valid-classmethod-first-arg=cls +valid-metaclass-classmethod-first-arg=mcs +exclude-protected=_asdict,_fields,_replace,_source,_make diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..c9de460 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2019 Timur Demin + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/project_amber/__init__.py b/project_amber/__init__.py new file mode 100644 index 0000000..2848263 --- /dev/null +++ b/project_amber/__init__.py @@ -0,0 +1,4 @@ +from project_amber.app import app + +if __name__ == "__main__": + app.run() diff --git a/project_amber/app.py b/project_amber/app.py new file mode 100644 index 0000000..7160bd9 --- /dev/null +++ b/project_amber/app.py @@ -0,0 +1,7 @@ +from flask import Flask + +app = Flask(__name__) + +@app.route("/") +def hello(): + return "works" diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..ef9e2d1 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,2 @@ +[metadata] +license_files = LICENSE.txt diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..2db8398 --- /dev/null +++ b/setup.py @@ -0,0 +1,25 @@ +#!/usr/bin/env python3 + +from setuptools import setup + +setup( + name="project_amber", + version="0.0.1", + description="The backend app of a note-taking app, Project Amber", + url="https://git.tdem.in/amber/backend", + author="Timur Demin", + author_email="me@tdem.in", + license="MIT", + classifiers=[ + "Development Status :: 3 - Alpha", + "License :: OSI Approved :: MIT License", + "Programming Language :: Python :: 3.6", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3" + ], + keywords="notes backend flask", + # project_urls={} + packages=["project_amber"], + install_requires=["flask"], + python_requires=">=3.6" +)