From 916f78841f993aff6b6a528413774c84193b7412 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20J=C4=99dyk?= Date: Sat, 20 Nov 2021 16:39:51 +0100 Subject: [PATCH] initial setup --- .gitignore | 142 +---------------------------------------------- README.md | 13 ++++- app.py | 14 +++++ requirements.txt | 2 + 4 files changed, 29 insertions(+), 142 deletions(-) create mode 100644 app.py create mode 100644 requirements.txt diff --git a/.gitignore b/.gitignore index f8b73e7..c3b4f44 100644 --- a/.gitignore +++ b/.gitignore @@ -1,140 +1,2 @@ -# ---> Python -# 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/ -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 -*.py,cover -.hypothesis/ -.pytest_cache/ -cover/ - -# 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 -.pybuilder/ -target/ - -# Jupyter Notebook -.ipynb_checkpoints - -# IPython -profile_default/ -ipython_config.py - -# pyenv -# For a library or package, you might want to ignore these files since the code is -# intended to run in multiple environments; otherwise, check them in: -# .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 - -# PEP 582; used by e.g. github.com/David-OConnor/pyflow -__pypackages__/ - -# Celery stuff -celerybeat-schedule -celerybeat.pid - -# 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/ - -# pytype static type analyzer -.pytype/ - -# Cython debug symbols -cython_debug/ - +__pycache__/* +venv/* \ No newline at end of file diff --git a/README.md b/README.md index da46461..acc961c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,12 @@ -# pbr-ayct-backend +# Backend application for PBR project (All You Can Tweet) -Backend application for PBR project (All You Can Tweet) \ No newline at end of file +To run project type: + +``` +pip3 install virtualenv +virtuvalenv venv +source venv/bin/activate +pip3 install setuptools +python3 -m pip install -r requirements.txt +flask run +``` \ No newline at end of file diff --git a/app.py b/app.py new file mode 100644 index 0000000..9b9a039 --- /dev/null +++ b/app.py @@ -0,0 +1,14 @@ +from flask import Flask +from flask_restful import Api, Resource + +app = Flask(__name__) +api = Api(app) + +class Hello(Resource): + def get(self): + return {"data": "All You Can Tweet"} + +api.add_resource(Hello, "/hello") + +if __name__ == "__main__": + app.run(debug=True) \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..2a47d39 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +Flask==2.0.2 +Flask-RESTful==0.3.9 \ No newline at end of file