Pyment is a website that tracks the production, storage, and distribution of my home-brewed mead.
Pyment was written in Python using the Django framework. The distribution portion of the website (the original catalog, the color scheme, the shopping cart, and other associated code) is based heavily upon the example site from "Beginning Django E-Commerce" by Jim McGaw.
This code is now in production. The database schemas and models should now be stable. There are a number of design decisions that I have made to support my specific environment: many jars of mead stored in multiple locations brewed during regularly-scheduled brewing events with multiple batches per event. Feel free to modify the code to match your particular needs -- I am especially interested in pull requests that improve the look and feel of the site!
The entire mead life cycle is now supported, from ingredients and recipes through batches and products. Individual ingredients can be defined as 'natural' or having a particular appellation. Batches are created from recipes with the recipe template values copied over. Recipes can in turn be created from batches as well. Recipes include projected original and final gravities as well as estimated volumes. Products can be created from batches, and labels can be generated from batches.
An inventory management system has been implemented, including support for multiple warehouses and picklists. A number of management commands have been added to facilitate capacity management and to aid in adding new product in bulk. Drill-down capability is now available on the admin site from warehouse to crate as well as a few other places.
Pyment requires Docker Engine 1.10.0+ and Docker Compose 1.6.0+.
The first step is to create or select a recipe. The recipes all follow the same pattern:
- Pour some honey into a bucket.
- Pour some warm water into the bucket, and stir until uniform.
- Pour some cool water into the bucket, and stir until uniform.
- (Optional) Add some flavoring to the bucket.
- Take sample, and record observations.
- Pitch yeast.
The information stored in the app focuses on the ingredients. For instance, multiple types of honey could be used for a particular recipe, or perhaps apple juice instead of water, or maybe some spices for flavor in the case of a metheglin.
The next step is to create a batch based on that recipe. The values for the recipe will be copied into the batch where they can be modified when the mead is actually brewed. If the batch's ingredients change significantly, a new recipe can be created. The batch includes space for observations such as temperature, specific gravity, and tasting notes. These observations will be useful for determining the strength of the mead and the flavor text for the labels among other factors. As the batch progresses, it will be updated with samples from time to time.
Once the batch is bottled, the final modifications to the batch are made, including the number of jars created. At this time, the labels can be printed and applied to the jars. When the jars are labeled, a product can be created from the batch. The jars can then be placed into the crates, and the database can be updated to reflect the new jars. That's it!
The site works like a standard e-commerce site, where orders can be placed. From the checkout admin site, the orders can be examined for errors. If no errors are found, the orders should be processed into pick lists. Pick lists identify specific jars in specific locations which must be retrieved to fulfill the order. Once the entire pick list is completed, it must be marked as processed so the order will be marked delivered.
Use the text editor of your choice to create a new file named django/local/.env. An example env file suitable for testing has been included at django/local/.env-example which includes all the required variables.
Modify the file to reflect your site's requirements. Generate your own secret key for Django and use it in the file. Sync the database and start the admin site. Create flatpages for "about" and "contact". This should be enough for the site itself to look right.
The cornerstone of the inventory model is the warehouse. Each warehouse should contain at least one row. Each row should contain at least one shelf. Each shelf should contain at least one bin (a section of shelf set aside for one or more crates). Using the admin site, create the warehouse first, then rows, then shelves, then bins.
The next step is to populate the meadery app. The meadery app stores the ingredients and recipes as well as batches. At least one recipe must be created as a basis for current and future batches and products. For batches currently in progress, it may be easiest to create the batch on the meadery admin site and supply the relevant information retroactively. Similarly, it may be easier to create existing products on the admin site. However, if the data is available and time permits, it is best to start from recipes and work through products as in the standard workflow.
For each crate in your warehouse, create a crate in the admin site and assign it to a bin. For each jar in that crate, create a jar in the admin site with the corresponding product data and assign it to that crate. That's it!
Once all the mead has been entered into the database, take another tour of the site to ensure that everything works as you expect.
Simple labels are created by default. Custom labels can be produced by creating a file 'meadery_local.py' in the meadery app which contains a 'generate_labels(batch)' function, plus any supporting code. If images are used on labels, they must be copied into the static directory and 'collectstatic' must be run.
There's a ./dev-setup.sh script which should do the right thing.
The SSL setup is a little hairy. To recreate it:
- Make a directory, and put this script in it: https://gist.github.com/mrw34/c97bb03ea1054afb551886ffc8b63c3b
./postgres.sh && sudo chown -R 999:130 . && sudo chmod 600 server.key && tar cf ~/git/pyment/devssl.tar .
After running the aforementioned script, try this: docker-compose run --rm web python -X dev manage.py test.
Copy the example env file mentioned above to the target location, re-run the script mentioned above, and try this: docker-compose up.
The example env file includes a reference to localhost in ALLOWED_HOSTS which makes the website work when visited at http://localhost:8000 for testing.
This software is released under the MIT license.