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.

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

Jump to bottom

Remove poetry.lock file #366

Merged
merged 3 commits into from
May 2, 2022
Merged

Remove poetry.lock file #366

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e91f2c7
Update scipy version to 1.7.3 in lock, and set Python version <3.11
cx1111 Apr 28, 2022
0261fed
Add instructions for applying formatting and installing dev dependencies
cx1111 Apr 28, 2022
7627689
Remove poetry.lock
cx1111 Apr 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,3 +72,6 @@ target/

# pyenv
.python-version

# Poetry
poetry.lock
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ poetry install
# With dev dependencies
pip install ".[dev]"
poetry install -E dev

# Install the dependencies only
poetry install -E dev --no-root
```

See the [note](#package-management) below about dev dependencies.
Expand All @@ -46,9 +49,15 @@ See the [note](#package-management) below about dev dependencies.

We welcome community contributions in the form of pull requests. When contributing code, please ensure:

- [PEP8](https://www.python.org/dev/peps/pep-0008/) style guidelines are followed.
- Documentation is provided. New functions and classes should have numpy/scipy style [docstrings](https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt).
- Unit tests are written for new features that are not covered by [existing tests](https://github.com/MIT-LCP/wfdb-python/tree/master/tests).
- The code style is consistent with the project's formating standards.
Copy link
Member

Choose a reason for hiding this comment

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

Typo in "formatting" and seems unrelated to PR topic but that's okay!


Run the formatter with:

```sh
black .
```

### Package Management

Expand Down