Skip to content

Generates digitization progress reports for project management of collections digitization projects.

License

Notifications You must be signed in to change notification settings

njdowdy/digitization_progress_reports

Repository files navigation

DIGITIZATION PROGRESS REPORTS

A resource for generating digitization effort graphs (or other efforts) on-the-fly.

More generally, for a series of entities (e.g., "Collections") and a series of activities (e.g., "High Resolution Images"), this project takes a count of:

  1. Total proposed units of activity
  2. Completed units of activity

combined with:

  1. Project Start
  2. Present Time Point
  3. Project End
  4. Project Extension End

and generates a figure like this:

A digitization effort plot

As a starting point, try the data template file here.

HOW TO USE

  1. Ensure docker is installed on your system (see: here)
  2. Ensure docker-compose is installed on your system (see: here)
  3. Run from the directory of your choice:
    • git clone https://github.com/njdowdy/digitization_progress_reports.git
    • cd digitization_progress_reports
  4. Add your file to process into digitization_progress_reports/application/input/
  5. Adjust application/run.py to reflect the path to your file and adjust other options as needed
  6. Copy .env.example to a .env file within the same directory and adjust the environment variables as needed (it is recommended to keep the contents as is)
  7. Run: sudo make dc-start or sudo make dc-start-verbose to monitor console output

All commands

help Show this help menu
dc-stop Stop docker (might need sudo)
dc-start Start docker (might need sudo)
To update the source code:
  1. git pull origin

CONTACT

Please report issues or questions here.

About

Generates digitization progress reports for project management of collections digitization projects.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages