captest 0.13.2__tar.gz → 0.13.3rc1__tar.gz

captest-0.13.3rc1/.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# Migrate code style to Black with ruff
+c8a38a9222094d31fd28:1f72bf744d87c7386a64

captest-0.13.3rc1/.gitattributes

@@ -0,0 +1 @@
+captest/_version.py export-subst

captest-0.13.3rc1/.github/workflows/publish.yml

@@ -0,0 +1,37 @@
+name: Build and Publish to PyPI
+
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - "v*"
+
+jobs:
+  pypi:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    # Environment and permissions trusted publishing.
+    environment:
+      # Create this environment in the GitHub repository under Settings -> Environments
+      name: pypi
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Install Python 3.13
+        run: uv python install 3.13
+      - name: Build
+        run: uv build
+      # Check that basic features work and we didn't miss to include crucial files
+      - name: Smoke test (wheel)
+        run: uv run --isolated --no-project --with dist/*.whl tests/smoke_test.py
+      - name: Smoke test (source distribution)
+        run: uv run --isolated --no-project --with dist/*.tar.gz tests/smoke_test.py
+      - name: Publish
+        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+        run: uv publish

captest-0.13.3rc1/.github/workflows/pytest.yml

@@ -0,0 +1,57 @@
+name: pytest
+
+on:
+  pull_request:
+  push:
+    branches:
+    - master
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false  # don't cancel other matrix jobs when one fails
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v3
+
+      - name: Get tags
+        run: git fetch --depth=1 origin +refs/tags/*:refs/tags/*
+
+
+      - name: Install uv and python
+        uses: astral-sh/setup-uv@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: auto
+          cache-dependency-glob: |
+            **/pyproject.toml
+            **/uv.lock
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Ruff lint
+        run: uv run ruff check .
+
+      - name: Ruff format check
+        run: uv run ruff format --check .
+
+      - name: Import test
+        run: uv run python -c "import captest; print(captest.__version__)"
+
+      - name: Run tests
+        run: uv run pytest --cov-report=xml --cov=captest tests/
+
+      # - name: Upload coverage to Codecov
+      #   if: matrix.python-version == 3.7 && matrix.suffix == '' && matrix.os == 'ubuntu-latest' && matrix.environment-type == 'conda'
+      #   uses: codecov/codecov-action@v3
+      #   with:
+      #     fail_ci_if_error: true
+      #     verbose: true
+      #     flags: core  # flags are configured in codecov.yml

captest-0.13.3rc1/.gitignore

@@ -0,0 +1,117 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# untracked_bin
+untracked_bin/
+
+# Distribution / packaging
+dependency_licenses.txt
+get_ver.py
+build.sh
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+uv.lock
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+#data
+./data/
+
+# vscode
+/.vscode
+
+# setuptools-scm generated version file
+src/captest/_version.py

captest-0.13.3rc1/.justfile

@@ -0,0 +1,57 @@
+set dotenv-load # loads env variables from .env
+set shell := ["zsh", "-c"]
+
+# Delete dist folder and uv build
+build:
+	rm -r dist/
+	uv build
+
+# Run build and then publish to testpypi
+publish-to-testpypi: build
+	uv publish --index testpypi --token $UV_PUBLISH_TESTPYPI_TOKEN # token from .env
+
+# Lint using ruff
+lint file=".":
+	uv run ruff check --fix {{file}}
+
+# Format using ruff, applies black formatting
+fmt file=".":
+	uv run ruff format {{file}}
+
+# Run all tests
+test python-ver="3.12":
+	uv run --python {{python-ver}} pytest tests/
+
+# Run all tests without warnings
+test-wo-warnings python-ver="3.12":
+	uv run --python {{python-ver}} pytest tests/ --disable-warnings
+
+# Run all tests with coverage report
+test-cov:
+	uv run pytest --cov-report html --cov=src/captest tests/
+
+# Reminder on how to run a specific test module
+test-module-example:
+	@echo "To run a class of tests: "
+	@echo "uv run pytest tests/test_CapData.py::TestCapDataEmpty\n"
+	@echo "To run a specific test:"
+	@echo "uv run pytest tests/test_CapData.py::TestCapDataEmpty::test_capdata_empty\n"
+
+# Run a specific test 
+test-module module_name python-ver="3.12":
+	uv run --python {{python-ver}} pytest --disable-warnings tests/{{module_name}}
+
+# Test install package in new venv
+test-install python-ver="3.12":
+	uv venv ../_pvc_test_dir/.venv --python {{python-ver}}
+	uv pip install --python ../_pvc_test_dir/.venv ./dist/*.whl
+	cd ../_pvc_test_dir && .venv/bin/python -c "import captest; print(captest.__version__)"
+	rm -rf ../_pvc_test_dir
+
+# Check current version of package
+ver:
+	uv run python -c "import captest; print(captest.__version__)"
+
+# Build docs with sphinx-build
+docs:
+	uv run sphinx-build -M html ./docs/ ./docs/_build/

captest-0.13.3rc1/.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.14.13
+  hooks:
+    # Run the linter.
+    - id: ruff-check
+    # Run the formatter.
+    - id: ruff-format

captest-0.13.3rc1/CHANGELOG.md

@@ -0,0 +1,276 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+[0.13.3rc1]: https://github.com/pvcaptest/pvcaptest/compare/v0.13.2...v0.13.3rc1
+## [0.13.3rc1] - 2026-02-05
+### Changed
+- Migrated from versioneer to setuptools-scm for git-based version management
+- Migrated from setup.py to modern pyproject.toml with [project] section
+- Added uv for dependency management and development workflows
+- Updated version access to use `importlib.metadata.version()`
+- Updated `numpy` version constraint to `<2.4.0` for compatibility, temporarily
+- Updated `param` version constraint to `<2.0` for compatibility
+- Updated `pandas` version constraint to `<3.0` for compatibility, temporarily
+- Updated development status classifier to "4 - Beta"
+- Simplified license metadata format in pyproject.toml
+- Moved testing and documentation dependencies to dependency-groups
+- Updated read the docs configuration to use uv
+
+### Removed
+- setup.py (all configuration moved to pyproject.toml)
+- Versioneer dependency and configuration
+- scipy dependency (replaced scipy.stats.mode with pandas.Series.mode in July 2023, unused imports removed January 2026)
+
+### Added
+- setuptools-scm for automatic version generation from git tags
+- Modern pyproject.toml with complete project metadata
+- Just command runner (justfile) with development recipes
+- Just recipes for testing package builds and version checking
+- Just recipe for building docs
+- MAINTAINER.md documentation for project maintainers
+
+[0.13.2]: https://github.com/pvcaptest/pvcaptest/compare/v0.13.1...v0.13.2
+## [0.13.2] - 2025-07-17
+### Fixed
+- Change to nan for compatability with numpy 2.0
+- Update file_reader to warn but load empty csv files
+
+[0.13.1]: https://github.com/pvcaptest/pvcaptest/compare/v0.13.0...v0.13.1
+## [0.13.1] - 2024-06-05
+### Fixed
+- Issue 112 - plotting tool would plot only last curve for plots with more than 25 curves.
+
+[0.13.0]: https://github.com/pvcaptest/pvcaptest/compare/v0.12.1...v0.13.0
+## [0.13.0] - 2024-05-05
+### Added
+- `load_data` can read site location and system information for generating clear sky irradiance from a json or yaml file.
+- New plotting module with a plot function which replaces the CapData.plot method. The new plot function creates a panel dashboard with expanded functionality. Internally, removes
+the plotting dependency on the CapData.trans_keys attribute.
+- `loc` and `floc` can be used to retrieve the regression columns, similar to previous rview functionality by using `regcols`.
+
+### Changed
+- Removed the CapData `trans_keys ` attribute, which was a copy of the `column_groups` keys and would be modified by the old `CapData.plot` method. `trans_keys` made it difficult to create a `CapData` object without using the `load_data` function.
+- Replaces all uses of `view` and `rview` with `loc` and `floc`.
+- Updated `loc` and `floc` to always return a DataFrame. Previously these would sometimes return a Series.
+- `load_data` now checks if any individual files were loaded when loading multiple files from a directory.
+- Adds underlay curve of unfiltered power to the linked timeseries created when calling `scatter_hv` with `timeseries=True`.
+- Changes selected points on scatter plot and linked timeseries produced by `scatter_hv` to red.
+- Tolerances may now be fractions eg '- 3.5'
+- The plotting methods `scatter_hv`, `scatter_filters`, and `timeseries_filters` do not require a column labeled 'index' with string datetimes in the `data` DataFrame anymore. Also, the index of the `data` DataFrame does not need to be named 'Timeseries'.
+- Removes the `add_index_col` kwarg option from `util.reindex`.
+
+[0.12.0]: https://github.com/pvcaptest/pvcaptest/compare/v0.11.2...v0.12.0
+## [0.12.0] - 2023-08-27
+### Added
+- Added a user guide section to the documentation with an overview and bifacial tests section.
+- Added verbose kwarg to the DataLoader load method, which prints which files have been loaded
+- DataLoader load method has new kwarg print_errors
+- DataLoader load method stores list of paths of files that fail to load in failed_to_load attribute
+- CapData method to save column_groups dictionary to excel
+- Github action to build and publish to PyPI on tags like v* pushed from master
+
+### Changed
+- Updates to make pvcaptest compatible with pvlib 0.10 and scipy 1.11
+- Update to make pvcaptest compatible with bokeh v3.0.0, change `plot_width` and `plot_height` to `width` and `height`
+- Make bokeh v3 minimum version
+- Drop support for python 3.7
+- Drop to_numeric from io.file_reader
+- CapData.column_groups is instance of ColumnGroups now when group_columns is a callable
+- Changed defaults for the CapData plot method to single column
+
+[0.11.2]: https://github.com/pvcaptest/pvcaptest/compare/v0.11.1...v0.11.2
+## [0.11.2] - 2023-04-20
+### Added
+- Adds CI testing across python 3.7 to 3.11 on OSX, Linux, and Windows using Github actions.
+
+### Changed
+- Re-organized project root directory to place captest package under a src directory, see PR #83.
+- Re-organized the extras for pip installation into optional, test, docs, and all. Updated the installation section of the docs to reflect change.
+- Updated installation instructions with links to pandas and conda docs for more information on environments.
+- Re-organized installation instructions.
+- Changed instructions on creating a conda env for pvcaptest to directly download the env yaml file from the repository rather than the whole repository.
+- Clean up RTD configuration, particularly added project directory to PYTHONPATH in the docs build environment, so the docs build against checked out version instead of installed version from conda.
+- Updates to documentation to add new modules, remove history section of releases, and remove references to Travis CI.
+
+### Fixed
+- Cleaned up issues in tests found after re-implementing CI on other platforms.
+
+[0.11.1]: https://github.com/pvcaptest/pvcaptest/compare/v0.11.0...v0.11.1
+## [0.11.1] - 2023-04-09
+### Added
+- Added new dependencies - colorcet, param
+- Added openpyxl as an optional dependency
+- Loads bokeh as holoviews extension in captest imports so user doesn't need to
+
+### Changed
+- Removed use of hvplot, replaced with holoviews to avoid adding unnecessary dependency. PR #73.
+
+### Fixed
+- Typo in the import check of panel
+
+[0.11.0]: https://github.com/pvcaptest/pvcaptest/compare/v0.10.0...v0.11.0
+## [0.11.0] - 2023-04-07 [YANKED]
+### Added
+- Added columngroups module with a ColumnGroups class that extends python
+dictionaries to include each column group as an attribute and __repr__ is
+formatted for easy reading.
+- Created the `loc` and `floc` callables for CapData, which allow easier access to columns of the `data` and `data_filtered` attributes, repsectively. Will replace `view` and `rview` method.
+- Added `read_json` function to util module.
+- Added `read_yaml` function to util module.
+- Added the io module with functions to load data and return instances of CapData containing the loaded data.
+- Added the ReportingIrradiance class for calculations of a reporting irradiance that is between the 40th and 60th percentile. `ReportingIrradiance.plot` includes a dashboard type view of the selected and possible reporting irradiance values and method to save possible reporting conditions table to csv.
+- Added the `spatial_uncert` and `expanded_uncert` methods. Improvements and testing needed.
+
+
+### Changed
+- Moved group_columns method, series_type, and type definitions from the capdata module to the columngroups module and changed group_columns from a CapData method to a function that returns a ColumnGroups instance.
+- Completely refactored the algorithim to determine the reporting irradiance when `irr_bal` is set to True. Now an instance of the new ReportingIrradiance class is created and used to determine the reporting irradiance.
+- Updated the examples to reflect the changes to the API for data loading, column grouping, selection (loc and floc vs view and rview), and balanced reporting irradiance.
+- Changed the `scatter_hv` method to be more flexible and not require temperature or wind regression columns.
+
+### Removed
+- Removed the value checking functionality of the group_columns function. Data quality is outside the scope of the pvcaptest project.
+- Removed the `load_data`, `load_das`, and `load_pvsyst` methods from the CapData class. Replaced with io module.
+
+
+
+[0.10.0]: https://github.com/pvcaptest/pvcaptest/compare/v0.9.0...v0.10.0
+## [0.10.0] - 2021-07-25
+### Added
+- Added the filter_missing CapData method to remove missing data from specified columns.
+By default removes only intervals that contain missing data in the regression variable
+columns.
+- Added option to filter_irr method to specify using the reporting irradiance in the CapData object as the reference irradiance.
+- Added option to the filter_time method to drop the specified time period instead of dropping all other times.
+- Added option to filter_clearsky method to keep time periods with unstable irradiance.
+- Added new attributes to CapData: removed, kept, filter_counts. The update_summary decorator now stores the
+index of points removed, the index of points remaining after each filter, and the number of times any filter has been run for each filter applied.
+- Adds new plotting method, scatter_filters, which shows which filtering step removed which time intervals of data in a plot of irradiance vs. power.
+- New plotting method, timeseries_filters, which shows which fitlering step removed which time intervals of data in a plot of power vs. time.
+- New plotting function, overlay_scatters, that overlays irradiance vs. power scatter plots of the data remaining after the last filtering step of the two CapData objects passed to the function.
+- New get_filtering_table method that returns a DataFrame documenting the which time intervals are removed by which filter and which time intervals remain after all filtering.
+- Adds the run_test function, which applies the passed list of CapData filtering methods to the CapData object passed.
+- Adds the points_summary method, which prints the number of points remaining after all filtering, the length of the test period, the average points remaining after filtering per day, if enough points have been collected, if
+more points are needed how many, and how many days left if the rate of points holds.
+
+### Changed
+- Updated filter_pvsyst method to handle inverter output variables that have underscores
+or spaces like 'IL Pmin' and 'IL_Pmin'.
+- load_das method no longer drops columns and rows that contain no data
+- Format of hover tooltip in plots produced by plot method now includes comma separator for thousands.
+- Changes captest to pvcaptest in documentation.
+- get_reg_cols method default changed to get and rename the columns defined in the `regression_cols` attribute
+rather than expecting regression variables/columns to be identified by the keys 'power', 'poa', 't_amb', and 'w_vel' in the `regression_cols` attribute.
+
+
+[0.9.0]: https://github.com/pvcaptest/pvcaptest/compare/v0.8.0...v0.9.0
+## [0.9.0] - 2020-08-16
+### Changed
+- Updated clear sky functions which rely on pandas `index.tz_localize` to use nonexistent argument rather than errors argument, which was deprecated in pandas v1.0.
+- Made Pandas v1.0 or greater a requirement for pvcaptest.
+- Change to test against python v3.7* and v3.8*
+- Updated installation instructions.
+
+
+[0.8.0]: https://github.com/pvcaptest/pvcaptest/compare/v0.7.0...v0.8.0
+## [0.8.0] - 2020-04-13
+### Added
+- Added a filter_power method to the CapData class.
+- Added a filter_days method to the CapData class.
+
+### Changed
+- Allow get_reg_cols to accept a single regression variable as a string. Previously required passing list with at least two entries.
+- Fixed bug in filter_clearksy that applied filter to data rather than data_filtered attribute.
+- Added option to plot method to use column names for hover labels instead of abbreviated column names.
+- Improved formatting of the filtering summary output. See issue #12 for details.
+- Cleaned up source code by correcting linter errors.
+
+[0.7.0]: https://github.com/pvcaptest/pvcaptest/compare/v0.6.0...v0.7.0
+## [0.7.0] - 2020-03-08
+### Added
+- New filter_shade method separate from the filter_pvsyst method.
+- captest_results method warns when it automatically attempts to correct for W vs kW.
+
+### Changed
+- Filter_pvsyst method filters on IL Pmin, IL Pmax, IL Vmin, and IL Vmax and warns if any of the four are missing. Previously failed if any of the four were missing.
+- cp_results returns a warning if the regression formulas of the passed CapData objects do not match instead of warning and continuing.
+- Updates to make captest compatible with pvlib 0.7.0
+- Editing of the complete capacity test example to use new names and improve explanations of features.
+
+Names were changed to remove ambiguous abbreviations:
+- flt - filter; API changes in many places
+- cntg_eoy - wrap_year_end; API change
+- cp_results - captest_results; API change
+- res_summary - captest_results_check_pvalues; API change
+- reg_fml - regression_formula; API change
+- irrRC_balanced - irr_rc_balanced; API change
+- df_beg - df_start
+- ix_ser - ix_series
+- mnth - month
+- months_boy - months_year_start
+- months_eoy - months_year_end
+- loop_cnt - loop_count
+- cprat - cap_ratio
+- cprat_cpval - cap_ratio_check_pvalues
+- trans - column_groups; API change
+- set_translation - group_columns
+- trans_report - column_type_report
+- set_trans argument of load_data - group_columns
+- review_trans - review_column_groups
+- set_reg_trans - set_regression_cols
+- reg_trans - regression_cols
+- update_reg_trans argument of agg_sensors - update_regression_cols
+- reg_cpt - fit_regression
+- ols_model - regression_results
+
+### Removed
+- Removed the inv_trans_dict function. This was intended for use within the module and was unused.
+
+[0.6.0]: https://github.com/pvcaptest/pvcaptest/compare/v0.5.3...v0.6.0
+## [0.6.0] - 2019-09-15
+### Added
+- Setup Travis CI to test pull requests and test and deploy to pypi for tags on master.
+- Setup project documentation hosted by Read the Docs using sphinx, nbshpinx, napolean, recommonmark, AutoStructify
+
+### Changed
+- Versioning changed from manual update in __version.py file to using versioneer to update version number from git tag.
+- Updated this file to follow the Keep a Changelog formatting conventions.
+- Moved repository to an organization github account from my personal github account.
+- Examples moved from root/examples directory to docs/examples. Executed versions of the examples display on read the docs.
+- All examples can be launched through binder in live notebooks.
+- The environment file has been updated to work for binder and Read the Docs.
+
+[0.5.3]: https://github.com/pvcaptest/pvcaptest/compare/v0.5.1...v0.5.3
+## [0.5.3] - 2019-05-12
+### Changed
+- Update name and location of conda environment yml file, so there is a single file and it works with binder.
+- Removed binder directory.
+- Update readme to reflect changes to conda environment.yml
+- Minor updates to example.
+- Minor documentation string updates.
+
+[0.5.1]: https://github.com/pvcaptest/pvcaptest/compare/v0.4.0...v0.5.1
+## [0.5.1] - 2019-05-01
+### Added
+- Addition of clear sky modeling using pvlib library.  See new example notebook 'Clear Sky Examples'.
+- Added a new method, `predict_capacities` for calculating reporting conditions and predicted outputs by month.
+- New example notebook demonstrating use of `rep_cond` and `predict_capacities`.
+- Add warning when filter removes all data.
+
+### Changed
+- Changed Holoviews dependency to >= v1.11.  DatLink added in v1.11 is required for scatter_hv method.
+- Expanded docstring for the load_data method to more clearly explain how the method joins multiple files (by row).
+- Update installation directions in README.
+- Updated conda environment file (conda_env.yml) to match updated dependencies.
+- **Moved all filtering and regression functionality from CapTest class into the CapData class and replace CapTest class with functions for results comparing CapData objects.**
+- **Significant refactor of the rep\_cond function.  Removed any time filtering and prediction from rep\_cond.  Rep\_cond acts on filtered data in the df\_flt attribute.**
+- `agg_sensors` method updated to be more explicit and flexible.
+- Changed `filter_sensors` to filter based on percent difference between all combinations of pairs of sensors measuring the same environmental factor.  Corrected bug where standard deviation filter could not detect outliers with more than two, but still a small number of sensors.
+- Adjusted bounds check of columns of data when importing so that translation dictionary names would not have 'valuesError' added to them.
+- Made printout of bounds check results optional when loading data.
+- Adjusted the type\_defs and sub\_type_defs, so that translation dictionary keys are more accurate for PVsyst data.

captest-0.13.3rc1/MAINTAINER.md

@@ -0,0 +1,72 @@
+# Maintainer Notes
+
+This document contains notes and procedures for project maintainers.
+
+## Just Task Runner
+
+This project is using [just](https://just.systems/man/en/introduction.html) to provide short nnames for recipes of common tasks, like building, running tests, and publishing.
+
+Install just with `uv tool install rust-just` or see the [packages](https://just.systems/man/en/packages.html) for other options.
+
+### Just notes
+- Run `just` commaonds from the project root directory
+- `just --list` shows available recipes
+- recipes are stored in `.justfile` in the project root directory
+
+## Pre-commit Hooks
+
+This project uses pre-commit to automatically run code quality checks before commits. The hooks include ruff for linting and formatting.
+
+### Setup
+
+After cloning the repository, install the pre-commit hooks:
+
+```bash
+pre-commit install
+```
+
+This will configure git to run the hooks automatically before each commit.
+
+### Running Manually
+
+To run pre-commit on all files without committing:
+
+```bash
+pre-commit run --all-files
+```
+
+Or, run ruff commands. Run `just --list` to see options.
+
+
+## Publishing to TestPyPI
+
+TestPyPI (test.pypi.org) is a separate instance of the Python Package Index for testing distribution tools and processes without affecting the real index.
+
+### One-time Setup
+
+1. **Create a TestPyPI account** at https://test.pypi.org
+
+2. **Generate an API token**:
+   - Log in to TestPyPI
+   - Go to Account Settings → API tokens
+   - Create a new token with appropriate scope
+   - Copy the token (it starts with `pypi-`)
+
+3. **Store the token securely**:
+   - save 'UV_PUBLISH_TESTPYPI_TOKEN="pypi-your-token-here" to .env
+
+4. **Ensure `.env` is in `.gitignore`**:
+   ```bash
+   echo '.env' >> .gitignore
+   ```
+
+### Publishing a Test Release
+
+1. **Build and publish**:
+    - Use the just command `publish-to-testpypi` to build and publish to test pypi server.
+
+### Notes
+
+- TestPyPI is completely separate from the production PyPI index
+- Packages and accounts on TestPyPI do not affect the real index
+- Use TestPyPI to verify the publishing process before releasing to production PyPI

captest-0.13.3rc1/MANIFEST.in

@@ -0,0 +1,2 @@
+include README.rst
+include LICENSE.txt