Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cleanup docs and deployment bits #10

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/debs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ jobs:

- name: Fetch debian files
run: |
wget https://launchpad.net/~nerdboy/+archive/ubuntu/embedded/+sourcefiles/timew-addons/0.1.1-1ubuntu1.22.04.1/timew-addons_0.1.1-1ubuntu1.22.04.1.debian.tar.xz
tar xf timew-addons_0.1.1-1ubuntu1.22.04.1.debian.tar.xz && rm *debian.tar.xz
wget https://launchpad.net/~nerdboy/+archive/ubuntu/embedded/+sourcefiles/timew-addons/0.3.0-1ubuntu1.20.04.1/timew-addons_0.3.0-1ubuntu1.20.04.1.debian.tar.xz
tar xf timew-addons_0.3.0-1ubuntu1.20.04.1.debian.tar.xz && rm *debian.tar.xz
ls

- name: Install deps and update debian changelog
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,8 @@ jobs:

- name: Fetch debian files
run: |
wget https://launchpad.net/~nerdboy/+archive/ubuntu/embedded/+sourcefiles/timew-addons/0.1.1-1ubuntu1.22.04.1/timew-addons_0.1.1-1ubuntu1.22.04.1.debian.tar.xz
tar xf timew-addons_0.1.1-1ubuntu1.22.04.1.debian.tar.xz && rm *debian.tar.xz
wget https://launchpad.net/~nerdboy/+archive/ubuntu/embedded/+sourcefiles/timew-addons/0.3.0-1ubuntu1.20.04.1/timew-addons_0.3.0-1ubuntu1.20.04.1.debian.tar.xz
tar xf timew-addons_0.3.0-1ubuntu1.20.04.1.debian.tar.xz && rm *debian.tar.xz
ls

- name: Install deps and update debian changelog
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ instance/

# Sphinx documentation
docs/_build/
docs/source/api/

# not-Sphinx documentation (externel)
docs/sum/
Expand Down
1 change: 1 addition & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ repos:
rev: v4.6.0
hooks:
- id: check-added-large-files
args: ["--maxkb=2000"]
- id: check-case-conflict
- id: check-merge-conflict
- id: check-symlinks
Expand Down
27 changes: 25 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,10 @@ and package overlays for Gentoo_ and Ubuntu.

Installing using system package manager is currently only supported on
Gentoo_ and requires `this portage overlay`_. Use one of the overlay
install methods shown in the readme_ file and sync the overlay; following
the overlay sync, install the package and dependencies::
install methods shown in the overlay readme_ file and sync the overlay;
following the overlay sync, install the package and dependencies::

$ sudo emaint sync -r embedded-overlay
$ sudo emerge timew-addons -v --ask

When available, use the following `Ubuntu PPA`_ to install on at least
Expand All @@ -82,6 +83,28 @@ installed and then add the PPA:

See `Adding this PPA to your system`_ for more info.

A somewhat manual approach using pre-built packages is available for debian
*bookworm*, *trixie*, and *sid*. First install the ``gdebi`` package::

$ sudo apt install gdebi

Next download the ``.deb`` packages for timew-report and timew-addons from
GitHub for your Debian version, eg, for bookworm do::

$ wget https://github.com/sarnold/timew-addons/releases/download/0.3.0/timew-addons_0.3.0-3+g478e08a-bookworm_all.deb
$ wget https://github.com/sarnold/timew-report/releases/download/v1.4.0/timew-report_1.4.0-10+gc66c7b7-bookworm_amd64.deb

Then install the ``.deb`` packages for timew-report and timew-addons from
GitHub using gdebi::

$ sudo gedbi timew-report_1.4.0-10+gc66c7b7-bookworm_amd64.deb
$ sudo gedbi timew-addons_0.3.0-3+g478e08a-bookworm_all.deb

.. important:: The exact package names and Debian release will be different.
Substitute the name of your Debian release and use the most
recent Github release page available.


.. _Adding this PPA to your system:
.. _this PPA:
.. _Ubuntu PPA: https://launchpad.net/~nerdboy/+archive/ubuntu/embedded
Expand Down
1 change: 1 addition & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
extensions = [
'rst2pdf.pdfbuilder',
'sphinxcontrib.apidoc',
'sphinx.ext.napoleon',
'sphinx.ext.doctest',
'sphinx.ext.todo',
'sphinx.ext.coverage',
Expand Down
2 changes: 1 addition & 1 deletion extensions/csv_rpt.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/usr/bin/env python
#!/usr/bin/env python3

import sys

Expand Down
2 changes: 1 addition & 1 deletion extensions/onelineday.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/usr/bin/env python
#!/usr/bin/env python3
'''
Modified from upstream example; extract a job-tag from the first
comma-separated split of the full tag string and produce subtotals
Expand Down
6 changes: 4 additions & 2 deletions scripts/timew-status-indicator
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import subprocess
import time
import typing
from collections import Counter
from datetime import timedelta
from datetime import datetime, timedelta
from decimal import Decimal
from threading import Thread
from typing import cast
Expand Down Expand Up @@ -180,11 +180,13 @@ class Indicator:
return menu

def about(self, source):
year = datetime.now().year
cpr_str = f'© {year} Stephen L Arnold'
dlg = Gtk.AboutDialog()
dlg.set_name('About...')
dlg.set_program_name('Timew Status Indicator')
dlg.set_version(APP_VERSION)
dlg.set_copyright('© 2024 Stephen L Arnold')
dlg.set_copyright(cpr_str)
dlg.set_license_type(Gtk.License.GPL_3_0)
dlg.set_logo_icon_name(get_state_icon('APP', CFG))
dlg.set_website('https://github.com/sarnold/timew-addons')
Expand Down