Skip to content

Commit 5ae9174

Browse files
MarcoMuellnerMarcoMuellner
committed
Initial commit
1 parent 0c266b7 commit 5ae9174

32 files changed

+3139
-1
lines changed

‎CODE_OF_CONDUCT.md

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

‎CONTRIBUTING.md

+115
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
# Contributor Guide
2+
3+
Thank you for your interest in improving this project.
4+
This project is open-source under the [MIT license] and
5+
welcomes contributions in the form of bug reports, feature requests, and pull requests.
6+
7+
Here is a list of important resources for contributors:
8+
9+
- [Source Code]
10+
- [Documentation]
11+
- [Issue Tracker]
12+
- [Code of Conduct]
13+
14+
[mit license]: https://opensource.org/licenses/MIT
15+
[source code]: https://github.com/MarcoMuellner/openapi-python-generator
16+
[documentation]: https://openapi-python-generator.readthedocs.io/
17+
[issue tracker]: https://github.com/MarcoMuellner/openapi-python-generator/issues
18+
19+
## How to report a bug
20+
21+
Report bugs on the [Issue Tracker].
22+
23+
When filing an issue, make sure to answer these questions:
24+
25+
- Which operating system and Python version are you using?
26+
- Which version of this project are you using?
27+
- What did you do?
28+
- What did you expect to see?
29+
- What did you see instead?
30+
31+
The best way to get your bug fixed is to provide a test case,
32+
and/or steps to reproduce the issue.
33+
34+
## How to request a feature
35+
36+
Request features on the [Issue Tracker].
37+
38+
## How to set up your development environment
39+
40+
You need Python 3.7+ and the following tools:
41+
42+
- [Poetry]
43+
- [Nox]
44+
- [nox-poetry]
45+
46+
Install the package with development requirements:
47+
48+
```console
49+
$ poetry install
50+
```
51+
52+
You can now run an interactive Python session,
53+
or the command-line interface:
54+
55+
```console
56+
$ poetry run python
57+
$ poetry run openapi-python-generator
58+
```
59+
60+
[poetry]: https://python-poetry.org/
61+
[nox]: https://nox.thea.codes/
62+
[nox-poetry]: https://nox-poetry.readthedocs.io/
63+
64+
## How to test the project
65+
66+
Run the full test suite:
67+
68+
```console
69+
$ nox
70+
```
71+
72+
List the available Nox sessions:
73+
74+
```console
75+
$ nox --list-sessions
76+
```
77+
78+
You can also run a specific Nox session.
79+
For example, invoke the unit test suite like this:
80+
81+
```console
82+
$ nox --session=tests
83+
```
84+
85+
Unit tests are located in the _tests_ directory,
86+
and are written using the [pytest] testing framework.
87+
88+
[pytest]: https://pytest.readthedocs.io/
89+
90+
## How to submit changes
91+
92+
Open a [pull request] to submit changes to this project.
93+
94+
Your pull request needs to meet the following guidelines for acceptance:
95+
96+
- The Nox test suite must pass without errors and warnings.
97+
- Include unit tests. This project maintains 100% code coverage.
98+
- If your changes add functionality, update the documentation accordingly.
99+
100+
Feel free to submit early, though—we can always iterate on this.
101+
102+
To run linting and code formatting checks before committing your change, you can install pre-commit as a Git hook by running the following command:
103+
104+
```console
105+
$ nox --session=pre-commit -- install
106+
```
107+
108+
It is recommended to open an issue before starting work on anything.
109+
This will allow a chance to talk it over with the owners and validate your approach.
110+
111+
[pull request]: https://github.com/MarcoMuellner/openapi-python-generator/pulls
112+
113+
<!-- github-only -->
114+
115+
[code of conduct]: CODE_OF_CONDUCT.md

‎LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2022 Marco Müllner
3+
Copyright © 2022 Marco Müllner
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎README.md

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Openapi Python Generator
2+
3+
[![PyPI](https://img.shields.io/pypi/v/openapi-python-generator.svg)][pypi_]
4+
[![Status](https://img.shields.io/pypi/status/openapi-python-generator.svg)][status]
5+
[![Python Version](https://img.shields.io/pypi/pyversions/openapi-python-generator)][python version]
6+
[![License](https://img.shields.io/pypi/l/openapi-python-generator)][license]
7+
8+
[![Read the documentation at https://openapi-python-generator.readthedocs.io/](https://img.shields.io/readthedocs/openapi-python-generator/latest.svg?label=Read%20the%20Docs)][read the docs]
9+
[![Tests](https://github.com/MarcoMuellner/openapi-python-generator/workflows/Tests/badge.svg)][tests]
10+
[![Codecov](https://codecov.io/gh/MarcoMuellner/openapi-python-generator/branch/main/graph/badge.svg)][codecov]
11+
12+
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
13+
[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]
14+
15+
[pypi_]: https://pypi.org/project/openapi-python-generator/
16+
[status]: https://pypi.org/project/openapi-python-generator/
17+
[python version]: https://pypi.org/project/openapi-python-generator
18+
[read the docs]: https://openapi-python-generator.readthedocs.io/
19+
[tests]: https://github.com/MarcoMuellner/openapi-python-generator/actions?workflow=Tests
20+
[codecov]: https://app.codecov.io/gh/MarcoMuellner/openapi-python-generator
21+
[pre-commit]: https://github.com/pre-commit/pre-commit
22+
[black]: https://github.com/psf/black
23+
24+
## Features
25+
26+
- TODO
27+
28+
## Requirements
29+
30+
- TODO
31+
32+
## Installation
33+
34+
You can install _Openapi Python Generator_ via [pip] from [PyPI]:
35+
36+
```console
37+
$ pip install openapi-python-generator
38+
```
39+
40+
## Usage
41+
42+
Please see the [Command-line Reference] for details.
43+
44+
## Contributing
45+
46+
Contributions are very welcome.
47+
To learn more, see the [Contributor Guide].
48+
49+
## License
50+
51+
Distributed under the terms of the [MIT license][license],
52+
_Openapi Python Generator_ is free and open source software.
53+
54+
## Issues
55+
56+
If you encounter any problems,
57+
please [file an issue] along with a detailed description.
58+
59+
## Credits
60+
61+
This project was generated from [@cjolowicz]'s [Hypermodern Python Cookiecutter] template.
62+
63+
[@cjolowicz]: https://github.com/cjolowicz
64+
[pypi]: https://pypi.org/
65+
[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
66+
[file an issue]: https://github.com/MarcoMuellner/openapi-python-generator/issues
67+
[pip]: https://pip.pypa.io/
68+
69+
<!-- github-only -->
70+
71+
[license]: https://github.com/MarcoMuellner/openapi-python-generator/blob/main/LICENSE
72+
[contributor guide]: https://github.com/MarcoMuellner/openapi-python-generator/blob/main/CONTRIBUTING.md
73+
[command-line reference]: https://openapi-python-generator.readthedocs.io/en/latest/usage.html

‎codecov.yml

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
comment: false
2+
coverage:
3+
status:
4+
project:
5+
default:
6+
target: "100"
7+
patch:
8+
default:
9+
target: "100"

‎docs/codeofconduct.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
```{include} ../CODE_OF_CONDUCT.md
2+
3+
```

‎docs/conf.py

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
"""Sphinx configuration."""
2+
project = "Openapi Python Generator"
3+
author = "Marco Müllner"
4+
copyright = "2022, Marco Müllner"
5+
extensions = [
6+
"sphinx.ext.autodoc",
7+
"sphinx.ext.napoleon",
8+
"sphinx_click",
9+
"myst_parser",
10+
]
11+
autodoc_typehints = "description"
12+
html_theme = "furo"

‎docs/contributing.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
```{include} ../CONTRIBUTING.md
2+
---
3+
end-before: <!-- github-only -->
4+
---
5+
```
6+
7+
[code of conduct]: codeofconduct

‎docs/index.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
```{include} ../README.md
2+
---
3+
end-before: <!-- github-only -->
4+
---
5+
```
6+
7+
[license]: license
8+
[contributor guide]: contributing
9+
[command-line reference]: usage
10+
11+
```{toctree}
12+
---
13+
hidden:
14+
maxdepth: 1
15+
---
16+
17+
usage
18+
reference
19+
contributing
20+
Code of Conduct <codeofconduct>
21+
License <license>
22+
Changelog <https://github.com/MarcoMuellner/openapi-python-generator/releases>
23+
```

‎docs/license.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# License
2+
3+
```{literalinclude} ../LICENSE
4+
---
5+
language: none
6+
---
7+
```

0 commit comments

Comments
 (0)