Skip to content

Commit

Permalink
Add links to resources for developing python packages
Browse files Browse the repository at this point in the history
  • Loading branch information
@ryan-kipawa
ryan-kipawa committed Oct 4, 2024
1 parent 1e7f1d2 commit 36e4005
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,12 @@ This repository serves as a template for creating a Python library

2. Change all occurences of `my_library` to match the name of your new library

3. Consider if the [license](LICENSE) should be modified.
3. Consider if the [license](LICENSE) should be modified.


## Additional resources

If you're interested in learning more about best practices for developing Python packages, check out the following resources:

- [Python Package Development at DHI](https://dhi.github.io/python-package-development/)
- [Scientific Python Library Development Guide](https://learn.scientific-python.org/development/)

1 comment on commit 36e4005

@jpalm3r
Copy link

@jpalm3r jpalm3r commented on 36e4005 Oct 8, 2024

Choose a reason for hiding this comment

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

Very small suggestion about point 2: we could add an extra comment about changing the my_library folder name. It has happened a few times that I look/replace for my_library instances but that will not change the folder name. Then, some commits down the line, I realize that I am still using a folder named my_library.

Please sign in to comment.