Package: rbwriter
Report Booklet WriterNever write a report booklet on your own again, Report Booklet Writer does it for you![Only supports German (DE) standard report booklets right now]AboutThis Project let's you save all your reports from single weeks into one big database, and when you feel like it, you can export all weeks correctly ordered and pixel perfect aligned into one PDF. Isn't that awesome?FeaturesNative Nginx & UWSGI supportNative Docker & Buildah support (relatively untested, be careful!)Multi-User-ManagementTodolist integrationReport Booklet OverviewExport-Everything-ButtonInstallationFrom PyPI (recommended):pipinstallrbwriter# Run it# -> make sure ~/.local/bin is on your PATH or you installed it with sudo for all usersrbwriterFrom GitHub (build from source):# First clone the projectgitclonehttps://github.com/TheCoder777/Report-Booklet-Writer.git# Change directorycdReport-Booklet-Writer# OPTIONAL: checkout the release you want# git checkout v0.1-alpha.1# Install requirementspipinstall.# Run it# -> make sure ~/.local/bin is on your PATH or you installed it with sudo for all usersrbwriterFrom GitHub releases:Downloadthe wheel (.whl) file from the releases section  (get the release you want)install withpip install *.whlrun withrbwriterWith Docker:# First clone the projectgitclonehttps://github.com/TheCoder777/Report-Booklet-Writer.git# Change directorycdReport-Booklet-Writer# OPTIONAL: checkout the release you want# git checkout v0.1-alpha.1# build container (make sure Docker is installed and working!)dockerbuild-t"some-example-tag".# run containerdockerrun-p80:80"some-example-tag"# stop containerdockerstop"some-example-tag"With Podman / Buildah:# First clone the projectgitclonehttps://github.com/TheCoder777/Report-Booklet-Writer.git# Change directorycdReport-Booklet-Writer# OPTIONAL: checkout the release you want# git checkout v0.1-alpha.1# build container (make sure Buildah and Podman are installed and working!)buildahbuild-using-dockerfile-t"some-example-tag"# run containerpodmanrun"some-example-tag"# stop containerpodmanstop"some-example-tag"UsageStart rbwriter, go tolocalhost:80(current default) and either click on 'create account' click the quickedit icon on sidebar (try to hover for a little bit!) or click on 'Use as Guest'.That's it!You can now either download the single PDFs in 'edit' mode, or export all to one PDF in the overview tab!UsersEvery account has a nickname that can be changed in the settings (it's pretty useless right now, but you'll use this to login later!)You Email needs to be in aname@provider.domainformatYour password needs to have:8 charactersone capital letterone numberone special characterNow you're logged in!Congratulations!ConfigurationYou can configure all settings via the web interface on /settings or by clicking on the settings icon in the sidebar!Do me a favor and be careful with some settings likestart weekandstart year, this often gets easily messed up.If you like the extreme, or you just want to mess around, you may also edit thedefines/configs.pyfile. (Do this on your own risk!)You'll be notified if everything went the correct way when you click the save button!To reset the configuration, just click the reset button! (This is to reset the values you put in since the last refresh)The 'reset to default button' will hard reset your configuration to absolute defaults, withno chance to restore your data, so please be careful with that!TroubleshootingTherbwritercommand doesn't exist:If therbwritercommand doesn't exist, you probably haven't set up your PATH correctly.Make sure that~/.local/bin(local installation) and/usr/lib/pythonx.x/site-packages/(global installation) are both on your PATH!You can check your path withecho $PATH.DebuggingYou can easily debug the project by using a 'debug' flag when running:rbwriterdebugThis will launch an instance of the flask development server on the defaultlocalhost:5000.Flask flags:All flags given torbwriterwill be handed over directly to theflask runcommand!Long-Term TodosUse a different Database structure!Maybe SQLAlchemyEvery user has its own table (not a completely different database...)Mail server (just wait for it, you'll see)Private/Public Profile settingall TODOs in the code (# TODO: ...)More flexible export (e.g. export from week 45 to 51 in 2021)Multiple PDF templatesMappings for easier supportSelect the PDF template before export (standard template in settings)New Frontend (right now it's pretty un-scalable for further features)Recommended Todolist-tasks to tick after saving a report bookletProgress of how much of the Todolist is done (on the Todolist page / stats page)Make a stats page with cool stats (how much words written or something like this)Search-bars everywhereLicenseThe project is licensed under theMIT license.This project has guidelines for:Code of ConductContributingCurrent maintainer and owner:TheCoder777Cheers!