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

requirements.yml file is missing #62

Closed
anilkumarpanda opened this issue Jan 25, 2021 · 3 comments
Closed

requirements.yml file is missing #62

anilkumarpanda opened this issue Jan 25, 2021 · 3 comments

Comments

@anilkumarpanda
Copy link
Contributor

requirements.yml file is missing.

@Matgrb
Copy link
Collaborator

Matgrb commented Jan 25, 2021

small correction: requirements.txt

Currently the requirements are described in setup.py in setup_requires section. These are the "must" have libraries to run probatus code. Indeed having a requirements.txt file would be useful for developers, e.g. we could place there the requirements for using mkdocs and pytest. Keep in mind there is currently requirements_test.txt file in tests/ folder.

I would say either we move the requirements.txt to the root, and add the mkdocs requirements, or we keep it as it is. What do you think?

@timvink
Copy link
Collaborator

timvink commented Jan 25, 2021

For packages I recommend defining all requirements 'sets' in setup.py. Sets would be: documentation, tests, development, core, and all. You define these sets via install_requires and extras_require.

You can then install what you need via pip install probatus[name-of-set].

For an example setup see https://github.com/koaning/scikit-lego/blob/master/setup.py

If we go this way, we should also update CONTRIBUTING.md and the different github action pipelines.

@anilkumarpanda
Copy link
Contributor Author

Sounds like a good idea. I will create a new issue for this and link this discussion there.

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

No branches or pull requests

3 participants