align to davidkhala@poetry-buildpack

davidkhala · Jan 3, 2025 · e369f33 · e369f33
1 parent 54f42c0
commit e369f33
Show file tree

Hide file tree

Showing 15 changed files with 24 additions and 136 deletions.
diff --git a/.github/workflows/libs.yml b/.github/workflows/libs.yml
@@ -8,9 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@main
-      - name: Install Poetry
-        uses: snok/install-poetry@main
-      - name: Install dependencies
-        run: poetry install --all-extras
-      - run: poetry run pytest
-        working-directory: test
+      - uses: davidkhala/poetry-buildpack@main
+        with:
+          test-entry-point: test
+
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -7,8 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@main
-      - name: Install Poetry
-        uses: snok/install-poetry@main
+      - uses: snok/install-poetry@main
       - run: poetry build
       - run: poetry config http-basic.pypi __token__ ${{secrets.PYPI_TOKEN}}
       - run: poetry publish
diff --git a/.gitignore b/.gitignore
@@ -1,128 +1,5 @@
-# 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
-*.py,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
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
-.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/
+.pytest_cache
+dist
+poetry.lock
+.idea
+__pycache__
diff --git a/poetry/README.md b/poetry/README.md
@@ -33,6 +33,16 @@ curl https://raw.githubusercontent.com/davidkhala/python-utils/refs/heads/main/p
 `poetry install --no-root` compared to `poetry update` 
 - Beyond dependencies, it can install current python module into context for reuse (e.g. use in tests)
 - It will respect lock file
+### non package mode
+by specify `package-mode = false` under section `[tool.poetry]`
+
+You can
+- skip requirements to specify mandatory `name`, `version`, `description` or `authors` value in section
+
+While you cannot
+- define scripts in the [tool.poetry.scripts] section
+- reference and import you local python module
+
 
 ## publish
 - `poetry publish --build` will prompt for confirm

diff --git a/pyproject.toml b/pyproject.toml
@@ -6,6 +6,9 @@ authors = ["David Liu <[email protected]>"]
 readme = "README.md"
 packages = [{ include = "davidkhala" }]
 
+[tool.poetry.scripts]
+test = "pytest:main"
+
 [tool.poetry.dependencies]
 python = "^3.10"
 # for extras

diff --git a/test/artifacts/.gitkeep b/test/artifacts/.gitkeep
diff --git a/test/.env → tests/.env b/test/.env → tests/.env
diff --git a/tests/artifacts/.gitignore b/tests/artifacts/.gitignore
@@ -0,0 +1 @@
+*.json
diff --git a/test/data/dummy.txt → tests/data/dummy.txt b/test/data/dummy.txt → tests/data/dummy.txt
diff --git a/test/data/test.sql → tests/data/test.sql b/test/data/test.sql → tests/data/test.sql
diff --git a/test/env_test.py → tests/env_test.py b/test/env_test.py → tests/env_test.py
diff --git a/test/http_request_test.py → tests/http_request_test.py b/test/http_request_test.py → tests/http_request_test.py
diff --git a/test/sql_test.py → tests/sql_test.py b/test/sql_test.py → tests/sql_test.py
diff --git a/test/syntax_test.py → tests/syntax_test.py b/test/syntax_test.py → tests/syntax_test.py
diff --git a/test/template_test.py → tests/template_test.py b/test/template_test.py → tests/template_test.py