Initial commit

This commit is contained in:
luchaos 2024-02-25 17:26:21 +01:00
commit 4f2f3aea68
No known key found for this signature in database
GPG Key ID: 168F223E269747E4
7 changed files with 99 additions and 0 deletions

15
.editorconfig Normal file
View File

@ -0,0 +1,15 @@
root = true
[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
indent_style = space
indent_size = 4
trim_trailing_whitespace = true
[*.md]
trim_trailing_whitespace = false
[*.{yml,yaml,neon,rc}]
indent_size = 2

11
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@ -0,0 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: Ask a question
url: https://github.com/RetroAchievements/api-python/discussions/new?category=q-a
about: Ask the community for help
- name: Request a feature
url: https://github.com/RetroAchievements/api-python/discussions/new?category=ideas
about: Share ideas for new features
- name: Report a bug
url: https://github.com/RetroAchievements/api-python/issues/new
about: Report a reproducable bug

3
CODE_OF_CONDUCT.md Normal file
View File

@ -0,0 +1,3 @@
## Code of Conduct
Please review and abide by the [Code of Conduct](https://docs.retroachievements.org/Users-Code-of-Conduct/).

1
CONTRIBUTING.md Normal file
View File

@ -0,0 +1 @@
# Contributing

21
LICENSE.md Normal file
View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2024 RetroAchievements.org
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

30
README.md Normal file
View File

@ -0,0 +1,30 @@
<p align="center" dir="auto"><a href="https://retroachievements.org" rel="nofollow"><img src="https://raw.githubusercontent.com/RetroAchievements/RAWeb/master/public/assets/images/ra-icon.webp" width="200" alt="RetroAchievements Logo" style="max-width: 100%;"></a></p>
<h1 align="center">RetroAchievements Web API Client</h1>
## Installation
WIP
## Usage
WIP
## Testing
WIP
## Contributing
See [Contribution Guidelines](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md).
## Security Vulnerabilities
Please review [our security policy](../../security/policy).
## Credits
- [All Contributors](../../contributors)
## License
MIT License (MIT). See [License File](LICENSE.md).

18
SECURITY.md Normal file
View File

@ -0,0 +1,18 @@
# Security Policy
The RAWeb team takes the security of the RetroAchievements platform seriously. If you discover a security issue, we appreciate your help in disclosing it to us in a responsible manner.
## Reporting a Vulnerability
Here's how you can report a security issue:
1. **Do not report security issues in GitHub issues, discussions, or on Discord.**
2. **Send a direct on-site message.** If you believe you've found a security vulnerability, [please send an on-site message to RAdmin](https://retroachievements.org/user/RAdmin).
In your report, please include:
- A brief description of the issue.
- Steps to reproduce the issue, if possible.
- Potential impact of the issue.
We will acknowledge your report within 48 hours of receiving it. We appreciate your help as we strive to keep our site as secure as possible. Thank you.