chore: config to run as local package
This commit is contained in:
parent
2769b4d1e5
commit
72b1a7ecf7
8 changed files with 34 additions and 9 deletions
22
README.md
22
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`.
|
||||
|
|
|
@ -1,2 +0,0 @@
|
|||
termcolor==2.5.0
|
||||
pyinstaller===6.11.0
|
4
setup.py
4
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={
|
||||
|
|
0
src/__init__.py
Normal file
0
src/__init__.py
Normal file
|
@ -1,3 +1,5 @@
|
|||
Metadata-Version: 2.1
|
||||
Name: neuron-zk-generator
|
||||
Version: 0.1
|
||||
Requires-Dist: termcolor
|
||||
Requires-Dist: pyinstaller
|
||||
|
|
|
@ -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
|
2
src/neuron_zk_generator.egg-info/requires.txt
Normal file
2
src/neuron_zk_generator.egg-info/requires.txt
Normal file
|
@ -0,0 +1,2 @@
|
|||
termcolor
|
||||
pyinstaller
|
|
@ -1 +1 @@
|
|||
|
||||
app
|
||||
|
|
Loading…
Add table
Reference in a new issue