Skip to content

Commit

Permalink
Add setup script
Browse files Browse the repository at this point in the history
  • Loading branch information
Stefan Oderbolz committed Sep 13, 2021
1 parent 0220738 commit e5a4605
Show file tree
Hide file tree
Showing 5 changed files with 88 additions and 2 deletions.
4 changes: 3 additions & 1 deletion .gitignore
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
27 changes: 27 additions & 0 deletions CHANGELOG.md
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
49 changes: 49 additions & 0 deletions CONTRIBUTING.md
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
2 changes: 1 addition & 1 deletion museumpy/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
__version__ = '0.1.2'
__version__ = '0.0.1'
__all__ = ['client', 'errors', 'response', 'xmlparse']

from .errors import MuseumPlusError
Expand Down
8 changes: 8 additions & 0 deletions setup.sh
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 .

0 comments on commit e5a4605

Please sign in to comment.