Skip to content

Commit a06464c

Browse files
author
Viacheslav Lisovoi
committed
docs: add project documentation and update metadata
Added CODE_OF_CONDUCT.md, CONTRIBUTING.md, and LICENSE.md to establish project standards and guidance for contributions. Updated setup.py with new metadata to reflect the current version and maintainership. These changes improve project organization and contributor clarity.
1 parent 18bf7f6 commit a06464c

File tree

4 files changed

+199
-4
lines changed

4 files changed

+199
-4
lines changed

‎CODE_OF_CONDUCT.md‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
- Demonstrating empathy and kindness toward other people
14+
- Being respectful of differing opinions, viewpoints, and experiences
15+
- Giving and gracefully accepting constructive feedback
16+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
- Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behavior include:
20+
21+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
22+
- Trolling, insulting or derogatory comments, and personal or political attacks
23+
- Public or private harassment
24+
- Publishing others' private information, such as a physical or email address, without their explicit permission
25+
- Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement Responsibilities
28+
29+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
32+
33+
## Scope
34+
35+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
36+
37+
## Enforcement
38+
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [viacheslav.lisovoi@onix-systems.com](mailto:viacheslav.lisovoi@onix-systems.com). All complaints will be reviewed and investigated promptly and fairly.
40+
41+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
42+
43+
## Enforcement Guidelines
44+
45+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
46+
47+
### 1. Correction
48+
49+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
50+
51+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
52+
53+
### 2. Warning
54+
55+
**Community Impact**: A violation through a single incident or series of actions.
56+
57+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
58+
59+
### 3. Temporary Ban
60+
61+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
62+
63+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
64+
65+
### 4. Permanent Ban
66+
67+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
68+
69+
**Consequence**: A permanent ban from any sort of public interaction within the community.
70+
71+
## Attribution
72+
73+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
74+
75+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
76+
77+
For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).
78+
79+
[homepage]: https://www.contributor-covenant.org

‎CONTRIBUTING.md‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
# Contributing to Python-Monobank-Client
2+
3+
First off, thank you for considering contributing to Python-Monobank-Client! It's people like you that make this project great!
4+
5+
## Code of Conduct
6+
7+
This project and everyone participating in it is governed by the [Python-Monobank-Client Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
8+
9+
## How Can I Contribute?
10+
11+
### Reporting Bugs
12+
13+
This section guides you through submitting a bug report for Python-Monobank-Client. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
14+
15+
#### Before Submitting A Bug Report
16+
17+
- **Perform a cursory search** in the [Issues section](https://github.com/Onix-Systems/python-monobank-client/issues) to see if the bug has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.
18+
19+
#### How Do I Submit A (Good) Bug Report?
20+
21+
Bugs are tracked as GitHub issues. After you've determined that a bug hasn't been filed, create an issue and provide the following information:
22+
23+
- **Use a clear and descriptive title** for the issue to identify the problem.
24+
- **Describe the exact steps** which reproduce the problem in as many details as possible.
25+
- **Provide specific examples** to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples.
26+
- **Describe the behavior you observed** after following the steps and point out what exactly is the problem with that behavior.
27+
- **Explain which behavior you expected to see** instead and why.
28+
- **Include screenshots** which show you following the described steps and clearly demonstrate the problem.
29+
- **If you're reporting that the library crashed**, include a crash report with a stack trace from the program.
30+
- **If the problem is related to performance**, include a CPU profile capture of the execution of the affected functions.
31+
32+
### Suggesting Enhancements
33+
34+
This section guides you through submitting an enhancement suggestion for Python-Monobank-Client, including completely new features and minor improvements to existing functionality.
35+
36+
#### Before Submitting An Enhancement Suggestion
37+
38+
- **Perform a cursory search** in the [Issues section](https://github.com/Onix-Systems/python-monobank-client/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
39+
40+
#### How Do I Submit A (Good) Enhancement Suggestion?
41+
42+
Enhancement suggestions are tracked as GitHub issues. After you've determined that the enhancement hasn't been filed, create an issue and provide the following information:
43+
44+
- **Use a clear and descriptive title** for the issue to identify the suggestion.
45+
- **Provide a step-by-step description of the suggested enhancement** in as much detail as possible.
46+
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why.
47+
- **Include screenshots and code snippets** which demonstrate the use of the suggested enhancement.
48+
49+
### Your First Code Contribution
50+
51+
- **Get started with our documentation**: follow the setup instructions in the [README.md](README.md) file.
52+
- **Check for open issues**: start by looking through the [Issues section](https://github.com/Onix-Systems/python-monobank-client/issues).
53+
54+
### Pull Requests
55+
56+
The process described here has several goals:
57+
58+
- Maintain the project's quality
59+
- Fix problems that are important to users
60+
- Engage the community in working toward the best possible Python-Monobank-Client
61+
- Enable a sustainable system for maintainers to review contributions
62+
63+
Please follow these steps to have your contribution considered by the maintainers:
64+
65+
1. **Create a branch** for your contribution.
66+
2. **Write tests** for your changes.
67+
3. **If you added code that should be tested, add tests**.
68+
4. **Ensure the test suite passes**.
69+
5. **Make sure your code lints.** Follow [PEP 8](https://www.python.org/dev/peps/pep-0008/) style guide.
70+
6. **Submit a pull request** through [GitHub](https://github.com/Onix-Systems/python-monobank-client/pulls).
71+
72+
---
73+
74+
## Code Style
75+
76+
- Follow the [PEP 8](https://www.python.org/dev/peps/pep-0008/) style guide.
77+
- Ensure that the code passes all linting checks.
78+
79+
### Tests
80+
81+
- Use [pytest](https://pytest.org/) for testing.
82+
- Ensure all tests pass before submitting a pull request. To run tests locally, follow these steps:
83+
84+
1. Install dependencies using `pip install -r requirements.txt`.
85+
2. Run the test suite using `pytest`.
86+
87+
---
88+
89+
## Licensing
90+
91+
By contributing to Python-Monobank-Client, you agree that your contributions will be licensed under the [MIT License](LICENSE).
92+
93+
---
94+
95+
Thank you for contributing to Python-Monobank-Client!

‎LICENSE.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Onix-Systems
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎setup.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ def readme():
77

88

99
setup(
10-
name="monobank_api_client",
11-
version="1.2.3",
12-
author="ihor.sotnyk",
13-
author_email="ihor.sotnyk@onix-systems.com",
10+
name="python-monobank-client",
11+
version="0.0.1",
12+
author="Viacheslav Lisovoi",
13+
author_email="viacheslav.lisovoi@onix-systems.com",
1414
description="This module is designed for quick interaction with the monobank API.",
1515
long_description=readme(),
1616
long_description_content_type="text/markdown",

0 commit comments

Comments
 (0)