Compare commits
	
		
			2 commits
		
	
	
		
			a14b97243c
			...
			76075f146c
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 76075f146c | |||
| d8c834095b | 
					 3 changed files with 42 additions and 13 deletions
				
			
		
							
								
								
									
										12
									
								
								CHANGELOG.md
									
										
									
									
									
								
							
							
						
						
									
										12
									
								
								CHANGELOG.md
									
										
									
									
									
								
							| 
						 | 
					@ -1,3 +1,15 @@
 | 
				
			||||||
 | 
					## v0.5.0 (2025-01-26)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### Feat
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- add pkg extras for postgres, mysql; update install doc
 | 
				
			||||||
 | 
					- allow basic support for item discounts
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### Fix
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- add setup hook to auto-create Order Admin role
 | 
				
			||||||
 | 
					- bugfix for view order item page template
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## v0.4.0 (2025-01-23)
 | 
					## v0.4.0 (2025-01-23)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Feat
 | 
					### Feat
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -8,22 +8,34 @@ Prerequisites
 | 
				
			||||||
-------------
 | 
					-------------
 | 
				
			||||||
 | 
					
 | 
				
			||||||
You'll need Python >= 3.8, and a database.  See also
 | 
					You'll need Python >= 3.8, and a database.  See also
 | 
				
			||||||
:doc:`wuttjamaican:narr/install/prereqs` in the Wutta docs.
 | 
					the Wutta docs:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					* :doc:`wuttjamaican:narr/install/prereqs`
 | 
				
			||||||
 | 
					* :ref:`wuttjamaican:create-appdb`
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					But for convenience here is a cheat sheet:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					*PostgreSQL*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
.. code-block:: sh
 | 
					.. code-block:: sh
 | 
				
			||||||
 | 
					
 | 
				
			||||||
   sudo apt install build-essential python3-dev python3-venv postgresql libpq-dev
 | 
					   sudo apt install build-essential python3-dev python3-venv postgresql libpq-dev
 | 
				
			||||||
 | 
					
 | 
				
			||||||
As for the database, see also :ref:`wuttjamaican:create-appdb` but FYI
 | 
					 | 
				
			||||||
these docs will assume a PostgreSQL setup with ``sideshow`` as the DB
 | 
					 | 
				
			||||||
name (and PG username).
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
.. code-block:: sh
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
   sudo -u postgres createuser sideshow
 | 
					   sudo -u postgres createuser sideshow
 | 
				
			||||||
   sudo -u postgres psql -c "ALTER USER sideshow PASSWORD 'mypassword'"
 | 
					   sudo -u postgres psql -c "ALTER USER sideshow PASSWORD 'mypassword'"
 | 
				
			||||||
   sudo -u postgres createdb -O sideshow sideshow
 | 
					   sudo -u postgres createdb -O sideshow sideshow
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					*MySQL*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					.. code-block:: sh
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					   sudo apt install build-essential python3-dev python3-venv default-mysql-server
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					   sudo mysql -e "CREATE USER sideshow@localhost"
 | 
				
			||||||
 | 
					   sudo mysql -e "ALTER USER sideshow@localhost  IDENTIFIED BY 'mypassword'"
 | 
				
			||||||
 | 
					   sudo mysqladmin create sideshow
 | 
				
			||||||
 | 
					   sudo mysql -e "GRANT ALL ON sideshow.* TO sideshow@localhost"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Virtual Environment
 | 
					Virtual Environment
 | 
				
			||||||
-------------------
 | 
					-------------------
 | 
				
			||||||
| 
						 | 
					@ -49,12 +61,16 @@ the folder ownership should be changed to whatever you need:
 | 
				
			||||||
Install Sideshow
 | 
					Install Sideshow
 | 
				
			||||||
----------------
 | 
					----------------
 | 
				
			||||||
 | 
					
 | 
				
			||||||
First install the Sideshow package to your virtual environment:
 | 
					First install the Sideshow package to your virtual environment.  Note
 | 
				
			||||||
 | 
					that you must specify which DB backend to use:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
.. code-block:: sh
 | 
					.. code-block:: sh
 | 
				
			||||||
 | 
					
 | 
				
			||||||
   cd /srv/envs/sideshow
 | 
					   # postgres
 | 
				
			||||||
   bin/pip install Sideshow
 | 
					   bin/pip install Sideshow[postgres]
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					   # mysql
 | 
				
			||||||
 | 
					   bin/pip install Sideshow[mysql]
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Then you can run the Sideshow installer:
 | 
					Then you can run the Sideshow installer:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
[project]
 | 
					[project]
 | 
				
			||||||
name = "Sideshow"
 | 
					name = "Sideshow"
 | 
				
			||||||
version = "0.4.0"
 | 
					version = "0.5.0"
 | 
				
			||||||
description = "Case/Special Order Tracker"
 | 
					description = "Case/Special Order Tracker"
 | 
				
			||||||
readme = "README.md"
 | 
					readme = "README.md"
 | 
				
			||||||
authors = [
 | 
					authors = [
 | 
				
			||||||
| 
						 | 
					@ -32,11 +32,12 @@ classifiers = [
 | 
				
			||||||
license = {text = "GNU General Public License v3+"}
 | 
					license = {text = "GNU General Public License v3+"}
 | 
				
			||||||
requires-python = ">= 3.8"
 | 
					requires-python = ">= 3.8"
 | 
				
			||||||
dependencies = [
 | 
					dependencies = [
 | 
				
			||||||
        "psycopg2",
 | 
					        "WuttaWeb>=0.20.6",
 | 
				
			||||||
        "WuttaWeb>=0.20.5",
 | 
					 | 
				
			||||||
]
 | 
					]
 | 
				
			||||||
 | 
					
 | 
				
			||||||
[project.optional-dependencies]
 | 
					[project.optional-dependencies]
 | 
				
			||||||
 | 
					postgres = ["psycopg2"]
 | 
				
			||||||
 | 
					mysql = ["mysql-connector-python"]
 | 
				
			||||||
docs = ["Sphinx", "furo", "sphinxcontrib-programoutput", "enum-tools[sphinx]"]
 | 
					docs = ["Sphinx", "furo", "sphinxcontrib-programoutput", "enum-tools[sphinx]"]
 | 
				
			||||||
tests = ["pytest-cov", "tox"]
 | 
					tests = ["pytest-cov", "tox"]
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue