Btibert3 / pypeds

Python package to facilitate and standardize enrollment science within higher education and Enrollment Management
https://www.linkedin.com/pulse/introducing-pypeds-brock-tibert/
GNU General Public License v3.0
9 stars 6 forks source link

Add requirements.txt for easier repo bootstrapping #22

Closed theletterjeff closed 1 year ago

theletterjeff commented 1 year ago

To ease the process of getting the development environment set up for pypeds, add a requirements.txt files that includes all third-party dependencies.

For info on creating/using requirements.txt files, see here. Note: requirements.txt is best paired with a virtual environment, e.g., one created using Python's venv module.

Btibert3 commented 1 year ago

The dev environment I use is conda and is shown in environment.yml, which I know can be a hot topic for some. This can likely be resolved via a simple export of the environment to requirements.txt. There has been some activity on the library used for export to Tableau hyperfiles, so that may need a resolution if packages get upgraded.

theletterjeff commented 1 year ago

There seem to be more dependencies in environment.yml than in the pyproject.toml file. Are there extra packages in environment.yml that don't pertain to pypeds?

I just built a requirements.txt file based on pyproject.toml (include the Tableau API dependencies). I'm going to try a clean clone on my Windows machine from my fork and install from there. Assuming it works, I'll open a pull request.