V3 (#615)

* switch back to devenv

Seems to work better for interactive development
Might have problems with the makefile in CI, we'll see

* remove api class

Only really useful for persistence and I'm going to remove that

* remove dependencies

Should have broken up dev and hdfs
oh well

* remove hdfs

Remove functionality and related tests
Coverage still looks good

* remove code coverage badge

Apparently I've let that lapse

* update docs

No more reference to API class, just link to modules

* Bump major version

I'm removing a ton of stuff, that's definitely a breaking change

* update lock file

* remove hdfs stuff

Could have sworn I did this before

* remove api class

Only really made sense with hdfs and other state management

* add extra field the api now returns

* convert to uv2nix

Author: ianepreston

.envrc

@@ -0,0 +1 @@
+use flake

.github/workflows/pypi.yml

@@ -8,16 +8,12 @@ on:
       - 'pyproject.toml'
 jobs:
   pypi:
+    permissions:
+      id-token: write
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
-    - uses: actions/setup-python@v5
-      with:
-        python-version: '3.11'
-        architecture: x64
-    - run: pip install poetry==1.8.3
-    - run: poetry build
-    - uses: pypa/gh-action-pypi-publish@release/v1
-      with:
-        user: __token__
-        password: ${{ secrets.PYPI_TOKEN }}
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - run: uv build
+      - run: uv publish

.github/workflows/test-pypi.yml

@@ -4,24 +4,16 @@ on:
     paths:
       - 'src/**'
       - 'pyproject.toml'
-
 jobs:
   test_pypi:
+    permissions:
+      id-token: write
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
-    - uses: actions/setup-python@v5
-      with:
-        python-version: '3.11'
-        architecture: x64
-    - run: pip install poetry==1.8.3
-    - run: >-
-        poetry version patch &&
-        version=$(poetry version | awk '{print $2}') &&
-        poetry version $version.dev.$(date +%s)
-    - run: poetry build
-    - uses: pypa/gh-action-pypi-publish@v1.0.0a0
-      with:
-        user: __token__
-        password: ${{ secrets.TEST_PYPI_TOKEN }}
-        repository_url: https://test.pypi.org/legacy/
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - run: >-
+          uv version --bump patch && version=$(uv version | awk '{print $2}') && uv version $version.dev.$(date +%s)
+      - run: uv build
+      - run: uv publish --index testpypi

.gitignore

@@ -125,3 +125,4 @@ dmypy.json
 
 #devenv
 .devenv
+.direnv

Makefile

@@ -1,12 +1,13 @@
 .PHONY: docs
 test:
-	nix develop --impure . -c ./.venv/bin/pre-commit run --all-files --show-diff-on-failure
-	nix develop --impure .#python39 -c ./.venv/bin/coverage run -m pytest
-	nix develop --impure .#python310 -c ./.venv/bin/coverage run -m pytest
-	nix develop --impure .#python311 -c ./.venv/bin/coverage run -m pytest
-	nix develop --impure .#python312 -c ./.venv/bin/coverage run -m pytest
-	nix develop --impure . -c ./.venv/bin/coverage report
+	nix develop --impure . -c pre-commit run --all-files --show-diff-on-failure
+	nix develop --impure . -c ruff check .
+	nix develop --impure .#python310 -c coverage run -m pytest
+	nix develop --impure .#python311 -c coverage run -m pytest
+	nix develop --impure .#python312 -c coverage run -m pytest
+	nix develop --impure .#python313 -c coverage run -m pytest
+	nix develop --impure . -c coverage report
 safety:
-	nix develop --impure . -c ./.venv/bin/safety check --file=poetry.lock --full-report
+	nix develop --impure . -c safety check --file=uv.lock --full-report
 docs:
-	nix develop --impure . -c ./.venv/bin/sphinx-build docs/source docs/_build
+	nix develop --impure . -c sphinx-build docs/source docs/_build

README.md

@@ -2,7 +2,6 @@
 
 [![Tests](https://github.com/ianepreston/stats_can/workflows/Tests/badge.svg)](https://github.com/ianepreston/stats_can/actions?workflow=Tests)
 [![Documentation Status](https://readthedocs.org/projects/stats-can/badge/?version=latest)](https://stats-can.readthedocs.io/en/latest/?badge=latest)
-[![codecov](https://codecov.io/gh/ianepreston/stats_can/branch/master/graph/badge.svg)](https://codecov.io/gh/ianepreston/stats_can)
 [![PyPI version](https://badge.fury.io/py/stats-can.svg)](https://badge.fury.io/py/stats-can)
 [![Anaconda-Server Badge](https://anaconda.org/conda-forge/stats_can/badges/version.svg)](https://anaconda.org/conda-forge/stats_can)
 

activate_env.sh

@@ -49,88 +49,25 @@ v3 branch in the project repo.
 
 Quickstart
 ==========
-After installing the stats_can package, all of the core functionality
-is available by instantiating a StatsCan object:
 
-::
-
-    from stats_can import StatsCan
-    sc = StatsCan()
-
-Without any arguments the StatsCan object will look for a file in the current
-working directory named "stats_can.h5". If it doesn't exist it will create one
-when it is first asked to load a table. You can also pass in a path in order
-to specify the location of the file. This is useful if you or a team want persistent
-access to certain tables.
-
-For example:
-::
-
-    sc = StatsCan(data_folder="~/stats_can_data")
-
-The most common use case for stats_can is simply to read in a table
-from Statistics Canada to a Pandas DataFrame. For example, table 271-000-22-01
-is "Personnel engaged in research and development by performing sector and occupational category"
-to read in that table (downloading it first if it's the first time accessing it) run:
-
-::
-
-    df = sc.table_to_df("271-000-22-01")
-
-If there are only a couple specific series of interest you can also
-read them into a dataframe (whether they're in different source tables or not) as follows:
-
-::
-
-    df = sc.vectors_to_df(["v74804", "v41692457"])
-
-The above command takes an optional start_date argument which will return
-a dataframe beginning with a reference date no earlier than the provided start date.
-By default it will return all available history for the V#s provided.
+Refer to the module index below for a list of the modules and the methods they contain.
 
-You can check which tables you have stored locally by running
-
-::
-
-    sc.downloaded_tables
-
-Which will return a list of table numbers.
-
-If a table is locally stored, it will not automatically update if
-Statistics Canada releases an update. To update locally stored tables
-run:
-
-::
-
-    sc.update_tables()
-
-You can optionally pass in a list of tables if you only want a subset of the
-locally stored tables to be updated.
-
-Finally, if you want to delete any tables you've loaded you can run:
-
-::
-
-    sc.delete_tables("271-000-22-01")
-
-StatsCan class documentation
-============================
-Core functions outlined in the Quickstart along with some extra
-functionality are described here:
+* :ref:`modindex`
 
-.. autoclass:: stats_can.api_class.StatsCan
-    :members:
+Generally if you want to call any of the endpoints of the service you can find a corresponding function
+in the scwds module, and higher level functions to read tables or vectors into a DataFrame are in the sc module
 
 Contributing
 ============
 
 Contributions to this project are welcome. Fork the repository from
 `github <https://github.com/ianepreston/stats_can>`_,
 
-You'll need a python environment with poetry and nox installed. A good guide for setting
+You'll need a python environment with poetry installed. A good guide for setting
 up an environment and project (that I used for this library) is `hypermodern python <https://cjolowicz.github.io/posts/hypermodern-python-01-setup/>`_.
 
-After making any changes you can run nox to make sure testing and linting went ok, and then you should be good to submit a PR.
+I've configured the project to use nix for environment creation. If you use nix then the makefile in the root of the project will let you create
+development environments and run tests. However you like to configure a poetry project should work though.
 
 I'd also welcome contributions to the docs, or anything else that would make this tool better for you or others.
 

docs/source/index.rst

@@ -4,21 +4,6 @@ stats\_can package
 Submodules
 ----------
 
-stats\_can.api_class module
----------------------------
-
-.. automodule:: stats_can.api_class
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-stats\_can.helpers module
--------------------------
-
-.. automodule:: stats_can.helpers
-    :members:
-    :undoc-members:
-    :show-inheritance:
 
 stats\_can.sc module
 --------------------
@@ -37,6 +22,14 @@ stats\_can.scwds module
     :show-inheritance:
 
 
+stats\_can.helpers module
+-------------------------
+
+.. automodule:: stats_can.helpers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 Module contents
 ---------------