bomshell 3.0.1__tar.gz

bomshell-3.0.1/.cookiecutterrc

@@ -0,0 +1,45 @@
+# This file exists so you can easily regenerate your project.
+#
+# `cookiepatcher` is a convenient shim around `cookiecutter`
+# for regenerating projects (it will generate a .cookiecutterrc
+# automatically for any template). To use it:
+#
+#    pip install cookiepatcher
+#    cookiepatcher gh:ionelmc/cookiecutter-pylibrary project-path
+#
+# See:
+#    https://pypi.python.org/pypi/cookiepatcher
+#
+# Alternatively, you can run:
+#
+#    cookiecutter --overwrite-if-exists --config-file=project-path/.cookiecutterrc gh:ionelmc/cookiecutter-pylibrary
+
+default_context:
+
+    codacy:                    'no'
+    codeclimate:               'no'
+    codecov:                   'yes'
+    command_line_interface:    'click'
+    command_line_interface_bin_name: 'bomshell'
+    coveralls:                 'no'
+    distribution_name:         'bomshell'
+    email:                     'sthysel@gmail.com'
+    full_name:                 'sthysel'
+    github_username:           'sthysel'
+    landscape:                 'no'
+    package_name:              'bomshell'
+    project_name:              'bomshell'
+    project_short_description: 'Retrieve weather data from the Australian  Bureau of Meteorology'
+    release_date:              'today'
+    repo_name:                 'bomshell'
+    requiresio:                'yes'
+    scrutinizer:               'no'
+    sphinx_doctest:            'no'
+    sphinx_theme:              'sphinx-rtd-theme'
+    test_matrix_configurator:  'no'
+    test_matrix_separate_coverage: 'no'
+    test_runner:               'pytest'
+    travis:                    'yes'
+    version:                   '0.1.0'
+    website:                   'http://sthysel.github.io/'
+    year:                      'now'

bomshell-3.0.1/.editorconfig

@@ -0,0 +1,13 @@
+# see http://editorconfig.org
+root = true
+
+[*]
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+charset = utf-8
+
+[*.{bat,cmd,ps1}]
+end_of_line = crlf

bomshell-3.0.1/.envrc

@@ -0,0 +1 @@
+source .venv/bin/activate

bomshell-3.0.1/.github/workflows/publish.yml

@@ -0,0 +1,21 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v5
+
+      - run: uv build
+
+      - uses: pypa/gh-action-pypi-publish@release/v1

bomshell-3.0.1/.gitignore

@@ -0,0 +1,68 @@
+*.py[cod]
+
+# C extensions
+*.so
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+.eggs
+parts
+bin
+var
+sdist
+wheelhouse
+develop-eggs
+.installed.cfg
+lib
+lib64
+venv*/
+pyvenv*/
+.venv/
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+.coverage.*
+nosetests.xml
+coverage.xml
+htmlcov
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+.idea
+*.iml
+*.komodoproject
+
+# Complexity
+output/*.html
+output/*/index.html
+
+# Sphinx
+docs/_build
+
+# Generated data files
+src/bomshell/data/
+
+.DS_Store
+*~
+.*.sw[po]
+.build
+.ve
+.env
+.cache
+.pytest
+.bootstrap
+.appveyor.token
+*.bak

bomshell-3.0.1/.pre-commit-config.yaml

@@ -0,0 +1,28 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-added-large-files
+        args: ['--maxkb=2000']
+      - id: check-merge-conflict
+      - id: debug-statements
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.4.10
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: local
+    hooks:
+      - id: ty
+        name: ty
+        entry: uvx ty check .
+        language: system
+        types: [python]
+        pass_filenames: false

bomshell-3.0.1/AUTHORS.rst

@@ -0,0 +1,5 @@
+
+Authors
+=======
+
+* sthysel - http://sthysel.github.io/

bomshell-3.0.1/CHANGELOG.rst

@@ -0,0 +1,8 @@
+
+Changelog
+=========
+
+0.1.0 (2017-04-22)
+------------------
+
+* First release on PyPI.

bomshell-3.0.1/CLAUDE.md

@@ -0,0 +1,67 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+Bomshell is a Python CLI tool for retrieving weather data from the Australian Bureau of Meteorology (BOM). It fetches spatial data from BOM's public FTP server and builds a local SQLite database for weather information queries.
+
+## Build and Test Commands
+
+Use `just` to run common development tasks:
+
+```bash
+just              # List all available recipes
+just install      # Install dependencies
+just test         # Run tests
+just test-cov     # Run tests with coverage
+just lint         # Lint code
+just fmt          # Format code
+just fix          # Auto-fix linting issues
+just typecheck    # Run ty
+just pre-commit   # Run all pre-commit hooks
+just qa           # Run lint + typecheck + test
+just build        # Build package
+just clean        # Clean build artifacts
+```
+
+Version management with bump-my-version:
+
+```bash
+just version      # Show current version
+just bump-patch   # Bump patch version (0.0.X)
+just bump-minor   # Bump minor version (0.X.0)
+just bump-major   # Bump major version (X.0.0)
+just bump-dry     # Dry run to preview changes
+```
+
+## Architecture
+
+### Entry Point
+- **CLI**: `src/bomshell/cli.py` - Click-based CLI with commands:
+  - `bomshell knobs` - Print configuration settings
+  - `bomshell spatial fetch/sync/build/csvdump/tabledump` - Spatial data management
+
+### Core Modules
+- `settings.py` - Configuration management with dotenv support, XDG base directories
+- `knobs.py` - Configuration registry (environment variables: `BOM_CACHE`, `BOM_FTP_TIMEOUT`, etc.)
+- `fetch_gis.py` - Spatial data fetching from BOM FTP, SQLite database creation
+- `fetch.py` - FTP file downloading utilities
+- `dump_gis.py` - Data export to CSV and formatted tables
+- `bom_paths.py` - BOM FTP server paths and data source documentation
+
+### Data Flow
+1. Fetch DBF spatial files from BOM FTP (`ftp.bom.gov.au`)
+2. Store in cache directory (`~/.cache/bomshell/spatial_cache/`)
+3. Build SQLite database (`~/.cache/bomshell/spatial.sqlite`)
+4. Query/export data via CLI
+
+### Configuration
+- Config file: `~/.bomshell` (dotenv format)
+- Generate defaults: `bomshell knobs > ~/.bomshell`
+
+## Code Style
+- Max line length: 140 characters
+- Python 3.10+ required
+- Uses ruff for linting and formatting
+- Pre-commit hooks enforce QA checks

bomshell-3.0.1/CONTRIBUTING.rst

@@ -0,0 +1,90 @@
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every
+little bit helps, and credit will always be given.
+
+Bug reports
+===========
+
+When `reporting a bug <https://github.com/sthysel/bomshell/issues>`_ please include:
+
+    * Your operating system name and version.
+    * Any details about your local setup that might be helpful in troubleshooting.
+    * Detailed steps to reproduce the bug.
+
+Documentation improvements
+==========================
+
+bomshell could always use more documentation, whether as part of the
+official bomshell docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Feature requests and feedback
+=============================
+
+The best way to send feedback is to file an issue at https://github.com/sthysel/bomshell/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that code contributions are welcome :)
+
+Development
+===========
+
+To set up `bomshell` for local development:
+
+1. Fork `bomshell <https://github.com/sthysel/bomshell>`_
+   (look for the "Fork" button).
+2. Clone your fork locally::
+
+    git clone git@github.com:your_name_here/bomshell.git
+
+3. Create a branch for local development::
+
+    git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally.
+
+4. When you're done making changes, run all the checks, doc builder and spell checker with `tox <http://tox.readthedocs.io/en/latest/install.html>`_ one command::
+
+    tox
+
+5. Commit your changes and push your branch to GitHub::
+
+    git add .
+    git commit -m "Your detailed description of your changes."
+    git push origin name-of-your-bugfix-or-feature
+
+6. Submit a pull request through the GitHub website.
+
+Pull Request Guidelines
+-----------------------
+
+If you need some code review or feedback while you're developing the code just make the pull request.
+
+For merging, you should:
+
+1. Include passing tests (run ``tox``) [1]_.
+2. Update documentation when there's new API, functionality etc.
+3. Add a note to ``CHANGELOG.rst`` about the changes.
+4. Add yourself to ``AUTHORS.rst``.
+
+.. [1] If you don't have all the necessary python versions available locally you can rely on Travis - it will
+       `run the tests <https://travis-ci.org/sthysel/bomshell/pull_requests>`_ for each change you add in the pull request.
+
+       It will be slower though ...
+
+Tips
+----
+
+To run a subset of tests::
+
+    tox -e envname -- py.test -k test_myfeature
+
+To run all the test environments in *parallel* (you need to ``pip install detox``)::
+
+    detox