From 72b1a7ecf75c0c0f9306d4e5dbc9625e92407a16 Mon Sep 17 00:00:00 2001 From: thomasabishop Date: Thu, 14 Nov 2024 13:17:26 +0000 Subject: [PATCH] chore: config to run as local package --- README.md | 22 +++++++++++++++---- requirements.txt | 2 -- setup.py | 4 ++-- src/__init__.py | 0 src/neuron_zk_generator.egg-info/PKG-INFO | 2 ++ src/neuron_zk_generator.egg-info/SOURCES.txt | 9 ++++++++ src/neuron_zk_generator.egg-info/requires.txt | 2 ++ .../top_level.txt | 2 +- 8 files changed, 34 insertions(+), 9 deletions(-) delete mode 100644 requirements.txt create mode 100644 src/__init__.py create mode 100644 src/neuron_zk_generator.egg-info/requires.txt diff --git a/README.md b/README.md index b1668fa..a32c9f9 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # `neuron-zk-generator` -This is a basic Python application that reads data from [my](https://github.com/thomasabishop/eolas) [zettelkasten](https://en.wikipedia.org/wiki/Zettelkasten) and -formats it so that it can be compiled as a [Neuron](https://neuron.zettel.page/) project and from there published as a static-site on the web. +This Python application reads data from [my](https://github.com/thomasabishop/eolas) [zettelkasten](https://en.wikipedia.org/wiki/Zettelkasten) and +formats it so that it can be compiled as a [Neuron](https://neuron.zettel.page/) project and from there published as a static-site on the Web. -## Running app in local development +## Local development ```sh source venv/bin/activate @@ -11,7 +11,21 @@ pip install -r requirements.txt neuron-zk-generator ``` -## Build standalone executable +## Run as local application + +``` +pipx install [local_path_to_application] +neuron-zk-generator +``` + +### Update after changes + +``` +pipx uninstall neuron-zk-generator +pipx install [local_path_to_application] +``` + +## Build single executable Use `pyinstaller` to create single executable file. `pyinstaller` is installed along with other packages in `requirements.txt`. diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index 5a101e3..0000000 --- a/requirements.txt +++ /dev/null @@ -1,2 +0,0 @@ -termcolor==2.5.0 -pyinstaller===6.11.0 diff --git a/setup.py b/setup.py index 6f0064d..c9c3e9a 100644 --- a/setup.py +++ b/setup.py @@ -1,9 +1,9 @@ -from setuptools import setup, find_packages +from setuptools import find_packages, setup setup( name="neuron-zk-generator", version="0.1", - packages=find_packages(where="src"), + py_modules=["app"], package_dir={"": "src"}, install_requires=["termcolor", "pyinstaller"], entry_points={ diff --git a/src/__init__.py b/src/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/neuron_zk_generator.egg-info/PKG-INFO b/src/neuron_zk_generator.egg-info/PKG-INFO index 69b57eb..9436d04 100644 --- a/src/neuron_zk_generator.egg-info/PKG-INFO +++ b/src/neuron_zk_generator.egg-info/PKG-INFO @@ -1,3 +1,5 @@ Metadata-Version: 2.1 Name: neuron-zk-generator Version: 0.1 +Requires-Dist: termcolor +Requires-Dist: pyinstaller diff --git a/src/neuron_zk_generator.egg-info/SOURCES.txt b/src/neuron_zk_generator.egg-info/SOURCES.txt index 9fee701..e4cdcf7 100644 --- a/src/neuron_zk_generator.egg-info/SOURCES.txt +++ b/src/neuron_zk_generator.egg-info/SOURCES.txt @@ -1,7 +1,16 @@ README.md setup.py +src/app.py +src/lib/__init__.py +src/lib/constants.py +src/lib/create_target_dir.py +src/lib/generate_index_file.py +src/lib/list_entries.py +src/lib/transfer_files.py +src/lib/transform_links.py src/neuron_zk_generator.egg-info/PKG-INFO src/neuron_zk_generator.egg-info/SOURCES.txt src/neuron_zk_generator.egg-info/dependency_links.txt src/neuron_zk_generator.egg-info/entry_points.txt +src/neuron_zk_generator.egg-info/requires.txt src/neuron_zk_generator.egg-info/top_level.txt \ No newline at end of file diff --git a/src/neuron_zk_generator.egg-info/requires.txt b/src/neuron_zk_generator.egg-info/requires.txt new file mode 100644 index 0000000..9976b19 --- /dev/null +++ b/src/neuron_zk_generator.egg-info/requires.txt @@ -0,0 +1,2 @@ +termcolor +pyinstaller diff --git a/src/neuron_zk_generator.egg-info/top_level.txt b/src/neuron_zk_generator.egg-info/top_level.txt index 8b13789..b80f0bd 100644 --- a/src/neuron_zk_generator.egg-info/top_level.txt +++ b/src/neuron_zk_generator.egg-info/top_level.txt @@ -1 +1 @@ - +app