-
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
1 parent
e4ced0d
commit b15b977
Showing
6 changed files
with
79 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 |
---|---|---|
@@ -0,0 +1,27 @@ | ||
<h1 align="center">Contributing</h1> | ||
|
||
Thank you for considering to contribute to this repository! | ||
|
||
In the spirit of open-source coding, we encourage contributions. Any help in making the API wrapper better is appreciated. | ||
|
||
## How to contribute | ||
* Create a [pull request](https://github.com/acatiadroid/pybloxlink/pulls) | ||
* Create an [issue](https://github.com/acatiadroid/pybloxlink/issues) | ||
|
||
## Guidelines to contribute | ||
To ensure a level of consistency, please do the following when making contributions where applicable: | ||
* Use short and straight to the point commit names. | ||
* Use the commit description to provide more information on the commit. | ||
* Don't use unnecessarily hateful speech in commits, PRs or issues. | ||
* Ensure commit names are relevant to the commit itself. | ||
* Don't be a dick in general. | ||
|
||
## Types of contributions we welcome | ||
* Bug fixes | ||
* Please heavily test bug fixes to ensure they don't create other bugs/impare functionally of anything. | ||
* Spelling mistakes | ||
* Syntax improvements | ||
* Feature requests/implimentations | ||
* Please DO NOT make PRs for implementing feature requests. Use issues instead as new features won't be implimented by anyone besides [acatia](https://github.com/acatiadroid). | ||
* Constructive criticism | ||
* Anything else providing it's beneficial |
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,6 @@ | ||
<div align="center"> | ||
<h1>PyBloxlink</h1> | ||
<h3>An API wrapper for the <a href="https://blox.link">blox.link</a> API.</h3> | ||
<img src="https://img.shields.io/pypi/v/pybloxlink.svg"> | ||
</div> | ||
|
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,2 +1,9 @@ | ||
__title__ = "pybloxlink", | ||
__author__ = "acatiadroid", | ||
__license__ = "MIT" | ||
__copyright__ = "Copyright 2023-present acatiadroid" | ||
__version__ = "0.1.0" | ||
|
||
from .client import Bloxlink | ||
from .objects import * | ||
from .objects import * | ||
from .exceptions import * |
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,37 @@ | ||
from setuptools import setup | ||
import re | ||
|
||
version = '' | ||
with open('bloxlink/__init__.py') as f: | ||
version = re.search(r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]', f.read(), re.MULTILINE).group(1) | ||
|
||
DESCRIPTION = "An API wrapper for the Bloxlink API." | ||
|
||
long_desc = "" | ||
with open(".github/README.md") as f: | ||
long_desc = f.read() | ||
|
||
setup( | ||
name="pybloxlink", | ||
version=version, | ||
author="acatiadroid", | ||
license="The MIT License (MIT)", | ||
author_email="<[email protected]>", | ||
url="https://github.com/acatiadroid/pybloxlink", | ||
project_urls={ | ||
"Issues": "https://github.com/acatiadroid/pybloxlink/issues" | ||
}, | ||
description=DESCRIPTION, | ||
long_description=long_desc, | ||
long_description_content_type="text/markdown", | ||
install_requires=["aiohttp"], | ||
keywords=["python", "bloxlink", "api wrapper"], | ||
classifiers=[ | ||
"Development Status :: 5 - Production/Stable", | ||
"Intended Audience :: Developers", | ||
"Programming Language :: Python :: 3", | ||
"Operating System :: Unix", | ||
"Operating System :: MacOS :: MacOS X", | ||
"Operating System :: Microsoft :: Windows", | ||
] | ||
) |