Skip to content

package name consistency #102

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 12, 2023
Merged

package name consistency #102

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions package-structure-code/python-package-structure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ If `tests/` are outside of the **src/package** directory, they aren't included i

By default, Python adds a module in your current working directory to the front of the Python module search path.

This means that if you run your tests in your packages working directory, using a flat layout, `/package/module.py`, Python will discover `package-name/module.py` file before it discovers the installed package.
This means that if you run your tests in your package's working directory, using a flat layout, `/package/module.py`, Python will discover `package/module.py` file before it discovers the installed package.

However, if your package lives in a src/ directory structure **src/package** then it won't be, by default, added to the Python path. This means that when you import your package, Python will be forced to search the active environment (which has your package installed).

Expand All @@ -109,7 +109,7 @@ We do not recommend including tests as part of your package wheel by default. Ho

```bash
src/
package-name/
package/
tests/
docs/
```
Expand Down Expand Up @@ -185,7 +185,7 @@ The flat layout's primary characteristics are:

- The source code for your package lives in a directory with your package's
name in the root of your directory
- Often the `tests/` directory also lives within that same `package-name` directory.
- Often the `tests/` directory also lives within that same `package` directory.

Below you can see the recommended structure of a scientific Python package
using the flat layout.
Expand Down