PyInventory 0.8.1rc2

Web based management to catalog things including state and location etc. using Python/Django.

Web based management to catalog things including state and location etc. using Python/Django.

The project is in an early stage of development. Some things are already implemented and usable. But there is still a lot to do.

Pull requests welcome!

	github.com/jedie/PyInventory/actions
	travis-ci.org/jedie/PyInventory
	codecov.io/gh/jedie/PyInventory
	coveralls.io/r/jedie/PyInventory
	landscape.io/github/jedie/PyInventory/master

about

The focus of this project is on the management of retro computing hardware.

Plan:

• Web-based

• Multiuser ready

• Chaotic warehousing

  • Grouped “Storage”: Graphics card is in computer XY

• Data structure kept as general as possible

• You should be able to add the following to the items:

  • Storage location

  • State

  • Pictures

  • URLs

  • receiving and delivering (when, from whom, at what price, etc.)

  • 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

install

There exists these kind of installation/usage:

• local development installation using poetry

• production use with docker-compose on a root server

• Install as YunoHost App via yinventory_ynh

This README contains only the information about local development installation.

Read /deployment/README for instruction to install PyInventory on a root server.

prepare

~$ git clone https://github.com/jedie/PyInventory.git
~$ cd PyInventory/
~/PyInventory$ make
_________________________________________________________________
PyInventory - *dev* Makefile

install-poetry         install or update poetry
install                install PyInventory via poetry
manage-update          Collectstatic + makemigration + migrate
update                 update the sources and installation
lint                   Run code formatters and linter
fix-code-style         Fix code formatting
tox-listenvs           List all tox test environments
tox                    Run pytest via tox with all environments
tox-py36               Run pytest via tox with *python v3.6*
tox-py37               Run pytest via tox with *python v3.7*
tox-py38               Run pytest via tox with *python v3.8*
pytest                 Run pytest
update-rst-readme      update README.rst from README.creole
publish                Release new version to PyPi
run-dev-server         Run the django dev server in endless loop.
createsuperuser        Create super user
messages               Make and compile locales message files
dbbackup               Backup database
dbrestore              Restore a database backup
run-docker-dev-server  Start docker containers with current dev source code

local development installation

# install or update Poetry:
~/PyInventory$ make install-poetry

# install PyInventory via poetry:
~/PyInventory$ make install
...

# Collectstatic + makemigration + migrate:
~/PyInventory$ make manage-update

# Create a django super user:
~/PyInventory$ ./manage.sh createsuperuser

# start local dev. web server:
~/PyInventory$ make run-dev-server

The web page is available via: http://127.0.0.1:8000/

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

Screenshots

---

---

---

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.:

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 “master” and “deployment” was merged into one. Files are separated into: “/src/” and “/development/”

history

• compare v0.8.0…master dev

  • Fix migration: Don’t create “/media/migrate.log” if there is nothing to migrate

  • Fix admin redirect by using the url pattern name

  • tbc

• v0.8.0 - 06.12.2020

  • Outsource the “MEDIA file serve” part into django.tools.serve_media_app

• v0.7.0 - 23.11.2020

  • 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

• v0.6.0 - 15.11.2020

  • User can store images to every item: The image can only be accessed by the same user.

• v0.5.0 - 14.11.2020

  • Merge separate git branches into one: “/src/” and “/development/” #19

• v0.4.2 - 13.11.2020

  • Serve static files by Caddy

  • Setup CKEditor file uploads: Store files into random sub directory

  • reduce CKEditor plugins

• v0.4.1 - 2.11.2020

  • Small bugfixes

• v0.4.0 - 1.11.2020

  • 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

• v0.3.2 - 26.10.2020

  • Bugfix missing translations

• v0.3.0 - 26.10.2020

  • 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

• v0.2.0 - 24.10.2020

  • Simplify item change list by nested item

  • Activate Django-Import/Export

  • Implement multi user usage

  • Add Django-dbbackup

  • Add docker-compose usage

• v0.1.0 - 17.10.2020

  • 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	http://github.com/jedie/PyInventory
PyPi	https://pypi.org/project/PyInventory/

Discuss here:

• vogons.org Forum Thread (en)

• Python-Forum (de)

• VzEkC e. V. Forum Thread (de)

• dosreloaded.de Forum Thread (de)

donation

• paypal.me/JensDiemer

• Flattr This!

• Send Bitcoins to 1823RZ5Md1Q2X5aSXRC5LRPcYdveCiVX6F

---

Note: this file is generated from README.creole 2020-12-09 11:11:42 with "python-creole"