-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Stefan Oderbolz
committed
Sep 13, 2021
1 parent
0220738
commit e5a4605
Showing
5 changed files
with
88 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
sruthi.egg-info | ||
museumpy.egg-info | ||
*.pyc | ||
*.swp | ||
.coverage | ||
pyenv | ||
.env |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# Changelog | ||
All notable changes to this project will be documented in this file. | ||
The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project follows [Semantic Versioning](http://semver.org/). | ||
|
||
## [Unreleased] | ||
|
||
## [0.0.2] - 2021-09-13 | ||
### Changed | ||
- Add possiblity to provide a `map_function` to parse custom fields | ||
|
||
## [0.0.1] - 2021-09-10 | ||
### Added | ||
- Initial release of museumpy | ||
|
||
|
||
|
||
# Categories | ||
- `Added` for new features. | ||
- `Changed` for changes in existing functionality. | ||
- `Deprecated` for once-stable features removed in upcoming releases. | ||
- `Removed` for deprecated features removed in this release. | ||
- `Fixed` for any bug fixes. | ||
- `Security` to invite users to upgrade in case of vulnerabilities. | ||
|
||
[Unreleased]: https://github.com/metaodi/museumpy/compare/v0.0.1...HEAD | ||
[0.0.2]: https://github.com/metaodi/museumpy/compare/v0.0.1...v0.0.2 | ||
[0.0.1]: https://github.com/metaodi/museumpy/releases/tag/v0.0.1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
# Contributing | ||
|
||
If you want to participate in this project, please follow this guidline. | ||
|
||
Fork and clone this repository: | ||
|
||
```bash | ||
git clone [email protected]:your-username/museumpy.git | ||
``` | ||
|
||
Install the dependencies using `pip`: | ||
|
||
```bash | ||
pip install -r requirements.txt | ||
pip install -r test-requirements.txt | ||
``` | ||
|
||
Make sure the tests pass: | ||
|
||
```bash | ||
pytest | ||
``` | ||
|
||
To ensure a good quality of the code use `flake8` to check the code style: | ||
|
||
```bash | ||
flake8 --install-hook git | ||
``` | ||
|
||
## Create a pull request | ||
|
||
1. Choose the `develop` branch as a target for new/changed functionality, `master` should only be targeted for urgent bugfixes. | ||
2. While it's not strictly required, it's highly recommended to create a new branch on your fork for each pull request. | ||
3. Push to your fork and [submit a pull request][pr]. | ||
4. Check if the [build ran successfully][ci] and try to improve your code if not. | ||
|
||
At this point you're waiting for my review. | ||
I might suggest some changes or improvements or alternatives. | ||
|
||
Some things that will increase the chance that your pull request is accepted: | ||
|
||
* Write tests. | ||
* Follow the Python style guide ([PEP-8][pep8]). | ||
* Write a [good commit message][commit]. | ||
|
||
[pr]: https://github.com/metaodi/sruthi/compare/ | ||
[ci]: https://github.com/metaodi/sruthi/actions | ||
[pep8]: https://www.python.org/dev/peps/pep-0008/ | ||
[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
#!/bin/bash | ||
|
||
[ ! -d pyenv ] && python -m venv pyenv | ||
source pyenv/bin/activate | ||
|
||
pip install --upgrade pip | ||
pip install -r requirements.txt | ||
pip install . |