Web based management to catalog things including state and location etc. using Python/Django.
Project description
Web based management to catalog things including state and location etc. using Python/Django. Store information in WYSIWYG-HTML-Editor field and tag them and add Files, Images and Links to them.
Pull requests welcome!
Install PyInventory with YunoHost. If you don’t have YunoHost, please consult the guide to learn how to install it.
about
The focus of this project is on the management of retro computing hardware.
Current features:
Web-based
Multiuser ready (Every user see and manage only his own entries)
Chaotic warehousing
Grouped “Items” e.g.: Graphics card Foo is in computer Bar
Data structure kept as general as possible
Manage information to every item:
Description: free WYSIWYG-HTML-Editor field
Storage location
State
Images, Files and Web-Links
receiving and delivering (when, from whom, at what price, etc.)
Manage “Memos” (Information independent of item/location):
A free WYSIWYG-HTML-Editor field
Tags
Images, Files and Web-Links
Future ideas:
** Information: Publicly visible yes/no
A public list of existing items (think about it, you can set in your profile if you want to)
administration a wish & exchange list
any many more… ;)
Project structure
There are two main directories:
directory |
description |
|---|---|
`/src/`_ |
The main PyInventory source code |
`/deployment/`_ |
deploy PyInventory for production use case (`DEPRECATED!`_) |
install
There exists these kind of installation/usage:
local development installation using poetry
production use with docker-compose on a root server (`DEPRECATED!`_)
Install as YunoHost App via pyinventory_ynh
This README contains only the information about local development installation.
Read /deployment/README for instruction to install PyInventory on a root server.
local development installation
e.g.:
# Clone project (Use your fork SSH url!): ~$ git clone https://github.com/jedie/PyInventory.git ~$ cd PyInventory ~/PyInventory$ ./devshell.py
Helpful for writing and debugging unittests is to run a local test server. e.g.:
~/PyInventory$ ./devshell.py run_testserver
The web page is available via: http://127.0.0.1:8000/
You can also pass a other port number or ipaddr:port combination. See: ./devshell.py run_testserver --help
Call manage commands from test project, e.g.:
~/PyInventory$ ./devshell.py manage --help
local docker dev run
You can run the deployment docker containers with current source code with:
~/PyInventory$ make run-docker-dev-server
Just hit Cntl-C to stop the containers
The web page is available via: https://localhost/
Screenshots
More screenshots are here: jedie.github.io/tree/master/screenshots/PyInventory
Multi user support
PyInventory supports multiple users. The idea:
Every normal user sees only his own created database entries
All users used the Django admin
Note: All created Tags are shared for all existing users!
So setup a normal user:
Set “Staff status”
Unset “Superuser status”
Add user to “normal_user” group
Don’t add any additional permissions
e.g.:
More screenshots are here: jedie.github.io/tree/master/screenshots/PyInventory
Backwards-incompatible changes
v0.7.0
Docker-Compose usage: The MEDIA files was not stored on a docker volumes.
You should backup rhe media files before update the containers!
e.g.:
~/PyInventory/deployment$ make shell_inventory root@inventory:/django# cp -Rfv /media/ /django_volumes/media/
The files are stored locally here:
~/PyInventory/deployment$ ls -la volumes/django/media/
Now, update the containers and copy the files back.
v0.5.0
Git branches “main” and “deployment” was merged into one. Files are separated into: “/src/” and “/development/”
history
-
tbc
-
Speedup item change list by prefetch “location”
Better changelists for super users
Add ./devsetup.py manage seed_data command to fill the database for development
Update requirements
Update project setup
-
Fix #102 by remove limitation of item parents.
Remove “Group Items” functionality
Replace “Group Items” change list filter by “Limit tree depth” for Item and Location.
Display Item and Location as a tree.
-
Rename git “master” branch into “main”
Update CI/Test setup:
Use darker and pytest-darker as code formatter
Run tests with Python 3.10, too and update requirements
Replace Selenium tests with Playwright
-
-
NEW: Protect user to overwrite newer Item/Memo/Location with a older one (e.g.: in other browser TAB)
update requirements
-
NEW: Memo model/admin: Store Information (incl. images/files/links) independent of items/locations
Bugfix CKEditor sizes and fix toolbar (e.g.: remove useless pdf generator button and add sourcecode function)
-
Update to Django 3.1.x
Don’t make requests to the a name for a Link, if we already have one or if last request was not long ago.
-
Group item: default “automatic” mode and can be disabled by filter action
-
Pin psycopg < 2.9 because of https://github.com/psycopg/psycopg2/issues/1293
-
Optimize “items” changelist queries
Update requirements
Expand run_testserver command and recognize address and port argument
-
Update requirements
NEW: Besides images, it’s now possible to add file(s) to items, too.
Add a auto login if Django dev. server is used.
-
Use https://github.com/jedie/dev-shell for development
-
Search items in change list by “kind” and “tags”, too
update requirements
-
update requirements
remove colorama from direct dependencies
Small project setup changes
-
Bugfix #33: Upload images to new created Items
-
Fix migration: Don’t create “/media/migrate.log” if there is nothing to migrate
Fix admin redirect by using the url pattern name
YunoHost app package created
update requirements
-
Outsource the “MEDIA file serve” part into django.tools.serve_media_app
-
Change deployment setup:
Replace uwsgi with gunicorn
make deploy setup more generic by renaming “inventory” to “django”
Bugfix MEDIA path: store the files on a docker volumes
run app server as normal user and not root
pull all docker images before build
-
User can store images to every item: The image can only be accessed by the same user.
-
Merge separate git branches into one: “/src/” and “/development/” #19
-
Serve static files by Caddy
Setup CKEditor file uploads: Store files into random sub directory
reduce CKEditor plugins
-
Small bugfixes
-
Move docker stuff and production use information into separate git branch
Add django-axes: keeping track of suspicious logins and brute-force attack blocking
Add django-processinfo: collect information about the running server processes
-
Bugfix missing translations
-
setup production usage:
Use caddy server as reverse proxy
Use uWSGI as application server
autogenerate secret.txt file for settings.SECRET_KEY
Fix settings
split settings for local development and production use
Bugfix init: move “setup user group” from checks into “post migrate” signal handler
Bugfix for using manage commands dumpdata and loaddata
-
Simplify item change list by nested item
Activate Django-Import/Export
Implement multi user usage
Add Django-dbbackup
Add docker-compose usage
-
Enhance models, admin and finish project setup
v0.0.1 - 14.10.2020
Just create a pre-alpha release to save the PyPi package name ;)
links
Homepage |
|
PyPi |
Discuss here:
donation
Note: this file is generated from README.creole 2022-08-19 09:18:39 with "python-creole"
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for PyInventory-0.15.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 28dfa414b3a746e68228e4e5cfd7cad440a98d7b96268f7505562906784e2216 |
|
| MD5 | cfbd448b146adddb6cde726905a7cf76 |
|
| BLAKE2b-256 | d33b2e29873fbbd89cef1f8ce51228870ed52ef3d2adbd0faaadfa50a35dd3de |
