mirror
/
PyInventory
kopia lustrzana https://github.com/jedie/PyInventory
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność
Web based management to catalog things including state and location etc. using Python/Django.
368 Commity
4 Gałęzie
62 Tagi
2,6 MiB
Python 64.4%
HTML 35.6%
 
 
Go to file
Jens Diemer d2ab3f633b
Merge pull request #115 from jedie/readme 
Readme
 		2022-08-29 21:19:22 +02:00
.github/workflows Fix coverage upload to codecov.io 2022-07-02 12:45:23 +02:00
deployment Release as v0.15.0 2022-08-19 09:21:27 +02:00
src Replace README.creole with README.md 2022-08-29 21:18:56 +02:00
.editorconfig fix project setup and "max line length" info 2022-07-28 21:09:31 +02:00
.flake8 Use https://github.com/jedie/dev-shell 2021-04-05 21:14:37 +02:00
.gitignore fix gitignore 2021-04-11 15:53:08 +02:00
.travis.yml init 2020-10-14 10:10:21 +02:00
AUTHORS Added translations to Catalan and Spanish. Po files need to be compiled. 2021-11-24 10:53:58 +01:00
LICENSE init 2020-10-14 10:10:21 +02:00
README.md Replace README.creole with README.md 2022-08-29 21:18:56 +02:00
devshell.py Update own bootstrap file from dev-shell via tests 2021-04-13 09:01:03 +02:00
poetry.lock Replace README.creole with README.md 2022-08-29 21:18:56 +02:00
pyproject.toml Replace README.creole with README.md 2022-08-29 21:18:56 +02:00

README.md

PyInventory

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.

Test Coverage Status on codecov.io PyInventory @ PyPi Python Versions License GPL

Install PyInventory with YunoHost

pyinventory_ynh allows you to install PyInventory quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Pull requests welcome!

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:

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

PyInventory v0.2.0 screenshot 1.png

PyInventory v0.11.0 screenshot memo 1.png

PyInventory v0.1.0 screenshot 2.png

PyInventory v0.1.0 screenshot 3.png

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

normal user example

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

links

| Homepage | http://github.com/jedie/PyInventory | | PyPi | https://pypi.org/project/PyInventory/ |

Discuss here:

donation