feat: add project infrastructure and licensing

Added an MIT license to establish the project's open source nature.
Initialized a README file for project documentation.

Reorganized project directory by moving manage.py to a 'coffeemachine' subdirectory.
Set up `pyproject.toml` using Poetry with necessary dependencies for the project environment, including Django and associated libraries for various functionalities (e.g., REST framework, storage, and authentication).

This setup provides a structured foundation for further development.
This commit is contained in:
Kumi 2024-08-01 14:25:39 +02:00
parent 37a41a7011
commit 3b8a578cc8
Signed by: kumi
GPG key ID: ECBCC9082395383F
4 changed files with 68 additions and 0 deletions

19
LICENSE Normal file
View file

@ -0,0 +1,19 @@
Copyright (c) 2024 Private.coffee Team <support@private.coffee>
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.

0
README.md Normal file
View file

49
pyproject.toml Normal file
View file

@ -0,0 +1,49 @@
[tool.poetry]
name = "coffeemachine"
version = "0.1.0"
description = ""
authors = ["Private.coffee Team <support@private.coffee>"]
license = "MIT"
readme = "README.md"
repository = "https://git.private.coffee/PrivateCoffee/coffeemachine"
[tool.poetry.dependencies]
python = "^3.10"
django = "^5.0"
djangorestframework = "*"
django-storages = "*"
django-polymorphic = "*"
setuptools = "*"
pillow = "*"
pygments = "*"
markdown = "*"
coreapi = "*"
pyyaml = "*"
django-autosecretkey = "*"
celery = "*"
redis = "*"
django-celery-results = "*"
django-celery-beat = "*"
drf-spectacular = {extras = ["sidecar"], version = "*"}
boto3 = "*"
argon2-cffi = "*"
django-csp = "*"
django-rest-polymorphic = "*"
django-crispy-forms = "*"
crispy-bootstrap5 = "*"
[tool.poetry.group.mysql.dependencies]
mysqlclient = "*"
[tool.poetry.group.postgres.dependencies]
psycopg2 = "*"
[tool.poetry.dev-dependencies]
pytest = "^5.2"
[tool.poetry.scripts]
coffeemachine = "coffeemachine.manage:main"
[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"