https://github.com/smkent/jobdb

https://github.com/smkent/jobdb

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/smkent/jobdb
• Owner: smkent
• License: gpl-3.0
• Created: 2024-06-22T06:05:10.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2025-01-15T22:49:28.000Z (4 months ago)
• Last Synced: 2025-01-28T14:15:08.150Z (4 months ago)
• Language: Python
• Size: 453 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# jobdb: Jobs database

[![Build](https://img.shields.io/github/checks-status/smkent/jobdb/main?label=build)][gh-actions]

[![codecov](https://codecov.io/gh/smkent/jobdb/branch/main/graph/badge.svg)][codecov]

[![GitHub stars](https://img.shields.io/github/stars/smkent/jobdb?style=social)][repo]

## Installation and usage with Docker

Example `docker-compose.yaml`:

```yaml

version: "3.7"

services:

  jobdb:

    image: ghcr.io/smkent/jobdb:latest

    restart: unless-stopped

```

Start the container by running:

```console

docker-compose up -d

```

Debugging information can be viewed in the container log:

```console

docker-compose logs -f

```

## Development

### [Poetry][poetry] installation

Via [`pipx`][pipx]:

```console

pip install pipx

pipx install poetry

pipx inject poetry poetry-pre-commit-plugin

```

Via `pip`:

```console

pip install poetry

poetry self add poetry-pre-commit-plugin

```

### Development tasks

* Setup: `poetry install`

* Run static checks: `poetry run poe lint` or

  `poetry run pre-commit run --all-files`

* Run static checks and tests: `poetry run poe test`

---

Created from [smkent/cookie-python][cookie-python] using

[cookiecutter][cookiecutter]

[codecov]: https://codecov.io/gh/smkent/jobdb

[cookie-python]: https://github.com/smkent/cookie-python

[cookiecutter]: https://github.com/cookiecutter/cookiecutter

[gh-actions]: https://github.com/smkent/jobdb/actions?query=branch%3Amain

[pipx]: https://pypa.github.io/pipx/

[poetry]: https://python-poetry.org/docs/#installation

[repo]: https://github.com/smkent/jobdb