Release installation fixes #40

Dronakurl · Jun 14, 2023 · 8a79413 · 8a79413
1 parent 6848e78
commit 8a79413
Show file tree

Hide file tree

Showing 6 changed files with 7 additions and 134 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
+openai.log
 __pycache__
 .env
 Archiv

diff --git a/README.rst b/README.rst
@@ -32,11 +32,11 @@ Usage
 How to install 
 --------------
 
-- Install the latest version with `pip`
+- Install the latest release version with `pip`
 
    .. code-block:: console
 
-      pip install 'git+https://github.com/Dronakurl/storytime.git#egg=storytime_ai[extras]'
+      pip install 'git+https://github.com/Dronakurl/storytime.git@0.2.0#egg=storytime_ai[extras]'
 
 - Set environment variable with openai api key (optional)
 

diff --git a/docs/development.md b/docs/development.md
@@ -20,10 +20,10 @@ deactivate; rm -rf venv;
 ## Installation of storytime_ai package from github repository
 
 ```
-deactivate; mkdir /tmp/test; cd /tmp/test; rm -rf venv
+deactivate; rm -fr /tmp/test/venv; mkdir /tmp/test; cd /tmp/test; rm -rf venv
 python -m venv venv; source venv/bin/activate
 
-pip install 'git+https://github.com/Dronakurl/storytime.git#egg=storytime_ai[extras]'
+pip install 'git+https://github.com/Dronakurl/storytime.git@0.2.0#egg=storytime_ai[extras]'
 
 python -c "from storytime_ai import Story; Story.from_markdown_file('/home/konrad/storytime/storytime_ai/templates/minimal.md').check_integrity()"
 python -c "from importlib.metadata import version; print(version('storytime_ai'))"

diff --git a/docs/usage.rst b/docs/usage.rst
@@ -11,6 +11,7 @@ How to install
    .. code-block:: console
 
       pip install 'git+https://github.com/Dronakurl/storytime.git#egg=storytime_ai[extras]'
+      pip install 'git+https://github.com/Dronakurl/storytime/releases/tag/0.2.0#egg=storytime_ai[extras]'
 
 - Set environment variable with openai api key (optional)