Init

.github/CONTRIBUTING.md

@@ -0,0 +1,34 @@
+<!-- TODO, write more about tox and poetry later -->
+
+# What you need.
+
+Install tox as mentioned [here](https://tox.wiki/en/latest/installation.html)
+
+Then install poetry as detailed [here](https://python-poetry.org/docs/#installation)
+
+
+
+## Adding a dependency
+Warning, never use pip to add a dependency. Nasty things are gonna
+happen if you ignore that advice.
+
+```
+$ poetry add yourdep yourdep2 ...
+```
+
+The command may take time due to dependency resolution sometimes, but
+if it exceeds 5 minutes it is abnormal. Usually it should be done before you notice.
+
+## Spawning a shell in the environment
+
+```
+$ poetry shell
+```
+
+You can learn more at https://python-poetry.org/docs/cli/
+
+## Running tests
+
+```
+$ tox r
+```

.github/workflows/tox.yml

@@ -0,0 +1,32 @@
+name: Tox
+
+on:
+  push:
+    branches: [ "*" ]
+  pull_request:
+    branches: [ "*" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [
+          "3.11",
+          "3.12"
+        ]
+
+    steps:
+      # TODO: Add caching
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Tox in Python ${{ matrix.python-version }}
+        run: |
+          python -m pip install tox-gh
+      - name: Run the tox environment (Python ${{ matrix.python-version }})
+        run: |
+          tox

.gitignore

@@ -0,0 +1,162 @@
+# 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
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__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/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+src/pwncore/utils.py

CONTRIBUTING.md

@@ -0,0 +1,89 @@
+# Git Commit Message Guide
+
+## Commit Message Structure
+
+Each commit message should generally follow this format:
+
+```
+<type>: <short summary>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+### 1. Adding a New File
+
+```
+feat: Add user authentication module
+```
+
+### 2. Adding New Functionality
+
+```
+feat: Implement password reset functionality
+```
+
+### 3. Updating Functionality
+
+```
+refactor: Improve search algorithm efficiency
+```
+
+### 4. Fixing Bugs
+
+```
+fix: Resolve login error for special characters
+```
+
+### 5. Removing Unused Code
+
+```
+chore: Remove deprecated user profile functions
+```
+
+### 6. Updating Documentation
+
+```
+docs: Update README with new API endpoints
+```
+
+### 7. Refactoring Code (without changing functionality)
+
+```
+refactor: Simplify error handling in payment module
+```
+
+### 8. Updating Dependencies
+
+```
+chore: Update dependencies to latest versions
+```
+
+### 9. Making Performance Improvements
+
+```
+perf: Optimize image loading on homepage
+```
+
+## Pull Requests
+
+```
+feat: Add user registration API endpoint
+
+- Implement POST /api/users/register
+- Add input validation and error handling
+- Create unit tests for the new endpoint
+
+Closes #123
+```
+
+```
+fix: Prevent race condition in concurrent file access
+
+- Implement file locking mechanism
+- Add timeout to prevent deadlocks
+- Update relevant documentation
+
+Bug: #456
+```

Dockerfile

@@ -0,0 +1,20 @@
+FROM python:3.12-slim
+
+WORKDIR /app
+
+RUN pip install poetry
+
+RUN poetry config virtualenvs.create false
+
+COPY pyproject.toml poetry.lock /app/
+RUN poetry install
+
+# Copy everything from src into /app/src
+COPY src /app/src
+
+WORKDIR /app/src
+
+EXPOSE 8000
+
+# Run FastAPI with Gunicorn
+CMD ["gunicorn", "-w", "4", "-k", "uvicorn.workers.UvicornWorker", "pwncore:app", "--bind", "0.0.0.0:8000", "--log-level", "debug"]