Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MNT] updates for release #297

Merged
merged 15 commits into from
Aug 1, 2024
6 changes: 3 additions & 3 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ commands:

jobs:
# Build treeple from source
build_scikit_tree:
build_treeple:
docker:
# CircleCI maintains a library of pre-built images
# documented at https://circleci.com/doc/2.0/circleci-images/
Expand Down Expand Up @@ -189,10 +189,10 @@ jobs:
workflows:
build-docs:
jobs:
- build_scikit_tree
- build_treeple
- build_docs:
requires:
- build_scikit_tree
- build_treeple
- docs-deploy:
requires:
- build_docs
Expand Down
5 changes: 4 additions & 1 deletion CITATION.cff
SUKI-O marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,12 @@ authors:
family-names: Xu
affiliation: "Department of Biomedical Engineering, Johns Hopkins University, Baltimore, MD, USA"
orcid: "https://orcid.org/0000-0001-8235-4950"
- given-names: Itsuki
family-names: Ogihara
affiliation: "Department of Biomedical Engineering, Johns Hopkins University, Baltimore, MD, USA"
type: software
repository-code: "https://github.com/neurodata/treeple"
license: 'BSD-3-Clause'
license: 'PolyForm-Noncommercial-1.0.0'
keywords:
- random forest
- oblique trees
Expand Down
3 changes: 3 additions & 0 deletions DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,11 +115,14 @@ In order to develop new tree models, generally Cython and C++ code will need to

treeple is in-line with scikit-learn and thus relies on each new version released there. Moreover, treeple relies on compiled code, so releases are a bit more complex than the typical Python package.

GH Actions will build wheels for each Python version and OS. Then the wheels needs to be uploaded to PyPi. The following steps outline the process:

1. Download wheels from GH Actions and put all wheels into a ``dist/`` folder

<https://github.com/neurodata/treeple/actions/workflows/build_wheels.yml> will have all the wheels for common OSes built for each Python version.

2. Upload wheels to test PyPi
This is to ensure that the wheels are built correctly and can be installed on a fresh environment. For more information, see <https://packaging.python.org/guides/using-testpypi/>. You will need to follow the instructions to create an account and get your API token for testpypi and pypi.

```
twine upload dist/* --repository testpypi
Expand Down
2 changes: 1 addition & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ We encourage you to use the package for your research and also build on top
with relevant Pull Requests. See our examples for walk-throughs of how to use the package.
Also, see our `contributing guide <https://github.com/neurodata/treeple/blob/main/CONTRIBUTING.md>`_.

We are licensed under BSD-3 (see `License <https://github.com/neurodata/treeple/blob/main/LICENSE>`_).
We are licensed under PolyForm Noncommercial License (see `License <https://github.com/neurodata/treeple/blob/main/LICENSE>`_).

.. topic:: References

Expand Down
4 changes: 2 additions & 2 deletions meson.build
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ project(
# Note that the git commit hash cannot be added dynamically here
# That only happens when importing from a git repository.
# See `treeple/__init__.py`
version: '0.9.0dev0',
license: 'BSD-3',
version: '0.9.1',
license: 'PolyForm Noncommercial 1.0.0',
meson_version: '>= 1.1.0',
default_options: [
'buildtype=debugoptimized',
Expand Down
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,20 @@ requires = [

[project]
name = "treeple"
version = "0.9.0dev0"
version = "0.9.1"
description = "Modern decision trees in Python"
maintainers = [
{name = "Neurodata", email = "adam.li@columbia.edu"}
]
documentation = "https://treeple.neurodata.io"
documentation = "https://treeple.ai"
repository = "https://github.com/neurodata/treeple"
readme = "README.md"
requires-python = ">=3.9"
classifiers = [
'Development Status :: 4 - Beta',
"Intended Audience :: Science/Research",
"Intended Audience :: Developers",
"License :: OSI Approved :: BSD License",
"License :: Free for non-commercial use",
"Programming Language :: C",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
Expand Down
Loading