From 96a6abf1e00c7510c825908cd084cb3a8faba7ba Mon Sep 17 00:00:00 2001 From: Deeman Date: Sat, 1 Mar 2025 18:11:57 +0100 Subject: [PATCH] Initial commit --- .gitignore | 174 ++++++++++++++++++++++++++++++++++ .python-version | 1 + README.md | 15 +++ notebooks/01_Experiment.ipynb | 10 ++ pyproject.toml | 17 ++++ src/materia/__init__.py | 2 + 6 files changed, 219 insertions(+) create mode 100644 .gitignore create mode 100644 .python-version create mode 100644 README.md create mode 100644 notebooks/01_Experiment.ipynb create mode 100644 pyproject.toml create mode 100644 src/materia/__init__.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0a19790 --- /dev/null +++ b/.gitignore @@ -0,0 +1,174 @@ +# 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 + +# UV +# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +#uv.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/latest/usage/project/#working-with-version-control +.pdm.toml +.pdm-python +.pdm-build/ + +# 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/ + +# Ruff stuff: +.ruff_cache/ + +# PyPI configuration file +.pypirc diff --git a/.python-version b/.python-version new file mode 100644 index 0000000..24ee5b1 --- /dev/null +++ b/.python-version @@ -0,0 +1 @@ +3.13 diff --git a/README.md b/README.md new file mode 100644 index 0000000..b4c79bc --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# Materia Environment Setup + +We use `uv` as our Python package manager for faster, more reliable dependency management. +https://docs.astral.sh/uv/ + +### 1. Install UV + +```bash +curl -LsSf https://astral.sh/uv/install.sh | sh +``` + +# Managing a project with uv + +https://docs.astral.sh/uv/guides/projects/#managing-dependencies + diff --git a/notebooks/01_Experiment.ipynb b/notebooks/01_Experiment.ipynb new file mode 100644 index 0000000..c55a287 --- /dev/null +++ b/notebooks/01_Experiment.ipynb @@ -0,0 +1,10 @@ +{ + "cells": [], + "metadata": { + "language_info": { + "name": "python" + } + }, + "nbformat": 4, + "nbformat_minor": 2 +} diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..622a904 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,17 @@ +[project] +name = "materia" +version = "0.1.0" +description = "Add your description here" +readme = "README.md" +authors = [ + { name = "Deeman", email = "hendrik.note@gmail.com" } +] +requires-python = ">=3.13" +dependencies = [] + +[project.scripts] +materia = "materia:main" + +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" diff --git a/src/materia/__init__.py b/src/materia/__init__.py new file mode 100644 index 0000000..e95c78c --- /dev/null +++ b/src/materia/__init__.py @@ -0,0 +1,2 @@ +def main() -> None: + print("Hello from materia!")