Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.
You can never have enough documentation! Please feel free to contribute to any part of the documentation, such as the official docs, docstrings, or even on the web in blog posts, articles, and such.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Ready to contribute? Here's how to set up your_package
for local development.
-
Download a copy of
your_package
locally. -
Install
poetry
-
The command below applies to UNIX systems (Mac/Linux).
$ curl -sSL https://install.python-poetry.org | python3 -
-
The command below applies to Windows. Run it in PowerShell (make sure you run PowerShell as an administrator).
-
You will also need to add the Poetry bin directory (printed during install) to your PATH environment variable
-
For activating environments etc. you may need to alter your PowerShell Execution Policy to
RemoteSigned
(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -
-
-
-
Install the package using
poetry
:-
Developers should install additional
poetry
groups for development:-
docs
for documentation dependencies -
lint
for linters.your_package
usesflake8
-
test
for testing utilities -
(optional)
debug
for debugging tools$ poetry install --with=docs,lint,test
-
-
If you are on Windows and attempting to install dependencies results in an error such as the one below, refer to the fix below:
Command "C:\Users\Abi Prakash\AppData\Local\Programs\Python\Python38\python.exe" -W ignore - errored with the following return code 1, and output: The system cannot find the path specified. C:\Users\Abi Prakash\AppData\Local\Programs\Python\Python38 input was : import sys if hasattr(sys, "real_prefix"): print(sys.real_prefix) elif hasattr(sys, "base_prefix"): print(sys.base_prefix) else: print(sys.prefix)
-
-
Use
git
(or similar) to create a branch for local development and make your changes:$ git checkout -b name-of-your-bugfix-or-feature
-
When you're done making changes, check that your changes conform to any code formatting requirements and pass any tests.
-
Commit your changes and open a pull request.
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include additional tests if appropriate.
- If the pull request adds functionality, the docs should be updated.
- The pull request should work for all currently supported operating systems and versions of Python.
If you get an error message similar to the one above, or one that returns an EnvCommandError
when you run poetry install -vv
follow these steps.
We will implement the fix described here:
-
Find where
poetry
source files are located. We are interested inenv.py
.- They are likely to be here:
C:\Users\<USER>\AppData\Roaming\pypoetry\venv\Lib\site-packages\poetry\utils
- If they are not, run
poetry install -vv
to get a stack trace and find whereenv.py
is located (this should be in the stack trace)
- They are likely to be here:
-
Find the
_run
method of classEnv
-
Comment out and add lines as demonstrated below (this is done in the last three line of the code block below)
def _run(self, cmd: list[str], **kwargs: Any) -> int | str: """ Run a command inside the Python environment. """ call = kwargs.pop("call", False) input_ = kwargs.pop("input_", None) env = kwargs.pop("env", dict(os.environ)) try: #if self._is_windows: # kwargs["shell"] = True kwargs["shell"] = False
-
Try
poetry install
again. It should now work.
Please note that the your_package
project is released with a
Code of Conduct. By contributing to this project you agree to abide by its terms.