Skip to content

Comments

Better handle py versions and installation instructions#487

Closed
stevebachmeier wants to merge 72 commits intorelease-candidate/v.orange.rebasedfrom
sbachmei/mic-5669/better-handle-supported-python-versions
Closed

Better handle py versions and installation instructions#487
stevebachmeier wants to merge 72 commits intorelease-candidate/v.orange.rebasedfrom
sbachmei/mic-5669/better-handle-supported-python-versions

Conversation

@stevebachmeier
Copy link
Contributor

@stevebachmeier stevebachmeier commented Feb 4, 2025

Better handle py versions and installation instructions

Description

  • Category: documentation
  • JIRA issue: MIC-5669

This does a couple of things:

  1. Tags the supported python versions in the README and reuses them in the docs
  2. Tags the installation instructions in the README and reuses them in the docs
  3. Automatically updates the README to match the python_versions.json.

Testing

  • all tests pass (pytest --runslow)

zmbc and others added 30 commits November 22, 2024 14:44
Refactors pseudopeople to create a class that encapsulates dataset schema, the data to be noised, a randomness stream, and the missingness attribute in one place.
- *Category*: Refactor
- *JIRA issue*: [MIC-4865](https://jira.ihme.washington.edu/browse/MIC-4865)

-creates new class to hold dataset schema, a pandas dataframe, a randomness stream, and a missingness bool dataframe
-updates fixtures and tests to reflect changes in the refactor

Testing
All tests pass
Mic-4865/Refactor/rename dataset

Renames Dataset to Dataset Schema and DatasetData to Dataset.
- *Category*: Refactor
- *JIRA issue*: [MIC-4865](https://jira.ihme.washington.edu/browse/MIC-4865)

-renames current dataset class to dataset_schema
-renames DatasetData to Dataset
-updates docstrings

Testing
All tests pass
Mic-4568/make-format

Adds Makefile to run formatters
- *Category*: Feature
- *JIRA issue*: [MIC-4568](https://jira.ihme.washington.edu/browse/MIC-4568)

-adds Makefile to include the following commands (which can be run from the terminal within your conda environment) for quality of life improvement for development:
    -`make format` which is running black and isort on the codebase
    -`make integration` which is running `pytest --runslow tests/`  
    -`make unit` which is running `pytest --runslow tests/unit/
`

Testing
Ran make format and saw expected behavior.
Mic-5132/no-any-return

Mic-5132/no-any-return
- *Category*: Other
- *JIRA issue*: [MIC-5132](https://jira.ihme.washington.edu/browse/MIC-5132)

-fixes instances of no-any-return issues with mypy
Mic-5155/return-value

Fix return-value mypy errors
- *Category*: Other
- *JIRA issue*: [MIC-XYZ](https://jira.ihme.washington.edu/browse/MIC-5155)

-fix return value mypy errors
* Pin numpy below 2.0

* fix noise type test

* change float to int

* remove arg-types

* fix layeredconfigtree

* fix state column names

* fix token probability

* fix expected noise

* fix target proportions

* fix generator errors

* fix user filters

* lint

* adjust to only float

* switch to generic types

* fix list and tuples builtin

* lint

* fix error

* add Optional

* revert optional

* try to validate overrides first instead

* make user_filters list instead of None

* make overrides Any type

* fix newlyt broken tests

* fix new errors

* remove return

* Revert "Merge remote-tracking branch 'origin/main' into mic-5154-arg-type"

This reverts commit 2b47eae, reversing
changes made to b8ecfdf.

* fix merge error

* lint

---------

Co-authored-by: albrja <albrja@uw.edu>
* fix overrides with property

* put property above
* fix mypy attr-defined errors

* update build workflow to use upstream dependency branches

* add layered config tree as a known third party

* don't install layered_config_tree inside the repository
@stevebachmeier stevebachmeier marked this pull request as ready for review February 4, 2025 21:29
version: 2
sphinx:
fail_on_warning: true
configuration: docs/source/conf.py
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

required for recent sphinx change

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep we did this on vivarium_research recently!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stevebachmeier You can delete this since you will need to rebase and that would probably make it easier for you

README.rst Outdated

$ git clone https://github.com/ihmeuw/pseudopeople.git
$ cd pseudopeople
$ python setup.py install
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a recommended way to install these days? I'd probably say pip install git+https://github.com/ihmeuw/pseudopeople.git

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought that was a weird bit of instructions but didn't know enough to change it.

@stevebachmeier stevebachmeier marked this pull request as draft February 5, 2025 16:53
@stevebachmeier stevebachmeier force-pushed the sbachmei/mic-5669/better-handle-supported-python-versions branch from 031de15 to 7f9d47b Compare February 5, 2025 17:02
@stevebachmeier stevebachmeier marked this pull request as ready for review February 5, 2025 17:06
@stevebachmeier stevebachmeier requested a review from zmbc February 5, 2025 17:06
@stevebachmeier stevebachmeier force-pushed the release-candidate/v.orange.rebased branch from 5966299 to 6fe4e45 Compare February 6, 2025 19:20
@stevebachmeier stevebachmeier deleted the sbachmei/mic-5669/better-handle-supported-python-versions branch February 6, 2025 19:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants