stadtreinigung_hamburg


Namestadtreinigung_hamburg JSON
Version 0.3.3 PyPI version JSON
download
home_pagehttps://github.com/vigonotion/stadtreinigung_hamburg
SummaryA library to get garbage collection dates in Hamburg.
upload_time2025-07-10 14:31:19
maintainerNone
docs_urlNone
authorTom Schneider
requires_python>=3.6.0
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Stadtreinigung Hamburg

[![PyPI](https://img.shields.io/pypi/v/stadtreinigung-hamburg.svg?logo=python&logoColor=white)](https://pypi.org/project/stadtreinigung-hamburg/)

This library provides access to garbage collection dates
in Hamburg. It scrapes the official website of Stadtreinigung Hamburg,
so this library can break at any time. Please open an issue if the
library does not work anymore.

## Installation

Using pip:

```
pip install stadtreinigung-hamburg
```

Using uv:

```
uv pip install stadtreinigung-hamburg
```

## Usage

After installing, use the terminal to run the program:

```
stadtreinigung_hamburg Sesamstraße 123
```


If your street name has a space, wrap the street in quotes:

```
stadtreinigung_hamburg "Sesame Street" 123
```


If you have problems with the street or street number,
use the official website and get the collection dates.
Then, search for `asId` and `hnId`. Those are the IDs for
your street and street number. You can use them too:

```
stadtreinigung_hamburg --asid 1234 --hnid 99999
```

Or mix it:

```
stadtreinigung_hamburg Sesamstraße --hnid 99999
```

## Development

This project uses [uv](https://github.com/astral-sh/uv) for dependency management and packaging.

### Setup Development Environment

```bash
# Install uv
curl -LsSf https://astral.sh/uv/install.sh | sh

# Create a virtual environment and install dependencies
uv venv
uv pip install -e .
```

### Building the package

```bash
uv build
```

### Publishing to PyPI

This project uses GitHub Actions with trusted publishing to automatically release to PyPI when a new GitHub release is created. The workflow uses PyPI's trusted publisher mechanism, which means no API tokens need to be stored in GitHub secrets.

To set up trusted publishing:

1. Go to PyPI and navigate to your project
2. Go to "Settings" > "Publishing"
3. Add a new publisher with:
   - Publisher: GitHub Actions
   - Organization: your-github-username
   - Repository: stadtreinigung_hamburg
   - Workflow name: Publish Python Package

Once configured, creating a new release on GitHub will automatically trigger a build and publish to PyPI.

#### Version Management

The package version is automatically set to match the GitHub release tag. When creating a new release:

1. Use semantic versioning for your tag (e.g., `v1.0.0`, `v1.0.1`)
2. The GitHub Action will extract the version number from the tag and update the package version before publishing

For local publishing (if you have the necessary permissions):

```bash
uv build
uv publish
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/vigonotion/stadtreinigung_hamburg",
    "name": "stadtreinigung_hamburg",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6.0",
    "maintainer_email": null,
    "keywords": null,
    "author": "Tom Schneider",
    "author_email": "Tom Schneider <tom@sutomaji.net>",
    "download_url": "https://files.pythonhosted.org/packages/75/93/b0db26f31f2d8c1572c4f027b46303c331d2cdc8e69c981f7f0b7d6998b6/stadtreinigung_hamburg-0.3.3.tar.gz",
    "platform": null,
    "description": "# Stadtreinigung Hamburg\n\n[![PyPI](https://img.shields.io/pypi/v/stadtreinigung-hamburg.svg?logo=python&logoColor=white)](https://pypi.org/project/stadtreinigung-hamburg/)\n\nThis library provides access to garbage collection dates\nin Hamburg. It scrapes the official website of Stadtreinigung Hamburg,\nso this library can break at any time. Please open an issue if the\nlibrary does not work anymore.\n\n## Installation\n\nUsing pip:\n\n```\npip install stadtreinigung-hamburg\n```\n\nUsing uv:\n\n```\nuv pip install stadtreinigung-hamburg\n```\n\n## Usage\n\nAfter installing, use the terminal to run the program:\n\n```\nstadtreinigung_hamburg Sesamstra\u00dfe 123\n```\n\n\nIf your street name has a space, wrap the street in quotes:\n\n```\nstadtreinigung_hamburg \"Sesame Street\" 123\n```\n\n\nIf you have problems with the street or street number,\nuse the official website and get the collection dates.\nThen, search for `asId` and `hnId`. Those are the IDs for\nyour street and street number. You can use them too:\n\n```\nstadtreinigung_hamburg --asid 1234 --hnid 99999\n```\n\nOr mix it:\n\n```\nstadtreinigung_hamburg Sesamstra\u00dfe --hnid 99999\n```\n\n## Development\n\nThis project uses [uv](https://github.com/astral-sh/uv) for dependency management and packaging.\n\n### Setup Development Environment\n\n```bash\n# Install uv\ncurl -LsSf https://astral.sh/uv/install.sh | sh\n\n# Create a virtual environment and install dependencies\nuv venv\nuv pip install -e .\n```\n\n### Building the package\n\n```bash\nuv build\n```\n\n### Publishing to PyPI\n\nThis project uses GitHub Actions with trusted publishing to automatically release to PyPI when a new GitHub release is created. The workflow uses PyPI's trusted publisher mechanism, which means no API tokens need to be stored in GitHub secrets.\n\nTo set up trusted publishing:\n\n1. Go to PyPI and navigate to your project\n2. Go to \"Settings\" > \"Publishing\"\n3. Add a new publisher with:\n   - Publisher: GitHub Actions\n   - Organization: your-github-username\n   - Repository: stadtreinigung_hamburg\n   - Workflow name: Publish Python Package\n\nOnce configured, creating a new release on GitHub will automatically trigger a build and publish to PyPI.\n\n#### Version Management\n\nThe package version is automatically set to match the GitHub release tag. When creating a new release:\n\n1. Use semantic versioning for your tag (e.g., `v1.0.0`, `v1.0.1`)\n2. The GitHub Action will extract the version number from the tag and update the package version before publishing\n\nFor local publishing (if you have the necessary permissions):\n\n```bash\nuv build\nuv publish\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A library to get garbage collection dates in Hamburg.",
    "version": "0.3.3",
    "project_urls": {
        "Homepage": "https://github.com/vigonotion/stadtreinigung_hamburg"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "0a75b20ed183ba8ce150cddd6b1f96742b0ceb466ad2c21017d91621ceba0894",
                "md5": "2db4fb157453469c33500d7532cad039",
                "sha256": "c265d0e9d8e9228912d49cd5fde1e4d422b25cecfd4ebdea829bb38a29dac1cb"
            },
            "downloads": -1,
            "filename": "stadtreinigung_hamburg-0.3.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2db4fb157453469c33500d7532cad039",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6.0",
            "size": 6637,
            "upload_time": "2025-07-10T14:31:18",
            "upload_time_iso_8601": "2025-07-10T14:31:18.607143Z",
            "url": "https://files.pythonhosted.org/packages/0a/75/b20ed183ba8ce150cddd6b1f96742b0ceb466ad2c21017d91621ceba0894/stadtreinigung_hamburg-0.3.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "7593b0db26f31f2d8c1572c4f027b46303c331d2cdc8e69c981f7f0b7d6998b6",
                "md5": "32ebba7aecf3d5fefc4d8f446681efc2",
                "sha256": "32e66338c1b51474952bd2db17baa38e1252d865fed552f48f4de6d4be357ece"
            },
            "downloads": -1,
            "filename": "stadtreinigung_hamburg-0.3.3.tar.gz",
            "has_sig": false,
            "md5_digest": "32ebba7aecf3d5fefc4d8f446681efc2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6.0",
            "size": 7772,
            "upload_time": "2025-07-10T14:31:19",
            "upload_time_iso_8601": "2025-07-10T14:31:19.672812Z",
            "url": "https://files.pythonhosted.org/packages/75/93/b0db26f31f2d8c1572c4f027b46303c331d2cdc8e69c981f7f0b7d6998b6/stadtreinigung_hamburg-0.3.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-10 14:31:19",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "vigonotion",
    "github_project": "stadtreinigung_hamburg",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "stadtreinigung_hamburg"
}
        
Elapsed time: 0.58621s