about summary refs log tree commit diff stats
path: root/templates/unmaintained/python/README.md
diff options
context:
space:
mode:
authorBenedikt Peetz <benedikt.peetz@b-peetz.de>2024-03-31 23:40:32 +0200
committerBenedikt Peetz <benedikt.peetz@b-peetz.de>2024-04-01 00:00:04 +0200
commit6df2ef639806567bf7ef9b3b50bef08b9cfb7e3a (patch)
tree60b33e862c20f8aff56949d40b197aec71eedb91 /templates/unmaintained/python/README.md
parentfeat(shell): Update to my new SOTA (diff)
downloadflake-templates-6df2ef639806567bf7ef9b3b50bef08b9cfb7e3a.tar.gz
flake-templates-6df2ef639806567bf7ef9b3b50bef08b9cfb7e3a.zip
refactor({python,markdown}): Also move them to the templates diretory
Diffstat (limited to 'templates/unmaintained/python/README.md')
-rw-r--r--templates/unmaintained/python/README.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/templates/unmaintained/python/README.md b/templates/unmaintained/python/README.md
new file mode 100644
index 0000000..aa95851
--- /dev/null
+++ b/templates/unmaintained/python/README.md
@@ -0,0 +1,46 @@
+# python-app
+
+## Setting up
+
+Rename `python_app` directory, name and main entrypoint in `setup.cfg`.
+
+## Using
+
+- running: `nix run`
+- dev shell (for IDE): `nix develop`
+- edit `setup.cfg` to add requirements (install_requires)
+- edit `requirements.txt` for dev shell requirements
+
+### Docker image
+
+- build: `nix build .#image -o image`
+- load to docker: `docker load < ./image`
+
+## Updating mach-nix pypi deps db
+
+Add to inputs:
+
+```nix
+pypi-deps-db = {
+  url = "github:davhau/pypi-deps-db/0000000000000000000000000000000000000000";
+  flake = false;
+};
+mach-nix.inputs.pypi-deps-db.follows = "pypi-deps-db";
+```
+
+## Adding git dependency
+
+Add to mkPython ([more info](https://github.com/DavHau/mach-nix/blob/master/examples.md)):
+
+```nix
+packagesExtra = [
+  (mach.buildPythonPackage
+    {
+      src = builtins.fetchGit {
+        url = "https://github.com/user/repo";
+        ref = "branch";
+        rev = "0000000000000000000000000000000000000000";
+      };
+    })
+];
+```