| Name | surferai JSON |
| Version |
0.1.7
JSON |
| download |
| home_page | https://github.com/CEREBRUS-MAXIMUS/surfer-python |
| Summary | The official Python library for the Surfer HumanAPI |
| upload_time | 2024-06-24 23:25:35 |
| maintainer | None |
| docs_url | None |
| author | Me |
| requires_python | >=3.7.1 |
| license | MIT License Copyright (c) 2023 JackBlair87 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. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# python-package-template
This is a template repository for Python package projects.
## In this README :point_down:
- [Features](#features)
- [Usage](#usage)
- [Initial setup](#initial-setup)
- [Creating releases](#creating-releases)
- [Projects using this template](#projects-using-this-template)
- [FAQ](#faq)
- [Contributing](#contributing)
## Features
This template repository comes with all of the boilerplate needed for:
⚙️ Robust (and free) CI with [GitHub Actions](https://github.com/features/actions):
- Unit tests ran with [PyTest](https://docs.pytest.org) against multiple Python versions and operating systems.
- Type checking with [mypy](https://github.com/python/mypy).
- Linting with [ruff](https://astral.sh/ruff).
- Formatting with [isort](https://pycqa.github.io/isort/) and [black](https://black.readthedocs.io/en/stable/).
🤖 [Dependabot](https://github.blog/2020-06-01-keep-all-your-packages-up-to-date-with-dependabot/) configuration to keep your dependencies up-to-date.
📄 Great looking API documentation built using [Sphinx](https://www.sphinx-doc.org/en/master/) (run `make docs` to preview).
🚀 Automatic GitHub and PyPI releases. Just follow the steps in [`RELEASE_PROCESS.md`](./RELEASE_PROCESS.md) to trigger a new release.
## Usage
### Initial setup
1. [Create a new repository](https://github.com/allenai/python-package-template/generate) from this template with the desired name of your project.
*Your project name (i.e. the name of the repository) and the name of the corresponding Python package don't necessarily need to match, but you might want to check on [PyPI](https://pypi.org/) first to see if the package name you want is already taken.*
2. Create a Python 3.8 or newer virtual environment.
*If you're not sure how to create a suitable Python environment, the easiest way is using [Miniconda](https://docs.conda.io/en/latest/miniconda.html). On a Mac, for example, you can install Miniconda using [Homebrew](https://brew.sh/):*
```
brew install miniconda
```
*Then you can create and activate a new Python environment by running:*
```
conda create -n my-package python=3.9
conda activate my-package
```
3. Now that you have a suitable Python environment, you're ready to personalize this repository. Just run:
```
pip install -r setup-requirements.txt
python scripts/personalize.py
```
And then follow the prompts.
:pencil: *NOTE: This script will overwrite the README in your repository.*
4. Commit and push your changes, then make sure all GitHub Actions jobs pass.
5. (Optional) If you plan on publishing your package to PyPI, add repository secrets for `PYPI_USERNAME` and `PYPI_PASSWORD`. To add these, go to "Settings" > "Secrets" > "Actions", and then click "New repository secret".
*If you don't have PyPI account yet, you can [create one for free](https://pypi.org/account/register/).*
6. (Optional) If you want to deploy your API docs to [readthedocs.org](https://readthedocs.org), go to the [readthedocs dashboard](https://readthedocs.org/dashboard/import/?) and import your new project.
Then click on the "Admin" button, navigate to "Automation Rules" in the sidebar, click "Add Rule", and then enter the following fields:
- **Description:** Publish new versions from tags
- **Match:** Custom Match
- **Custom match:** v[vV]
- **Version:** Tag
- **Action:** Activate version
Then hit "Save".
*After your first release, the docs will automatically be published to [your-project-name.readthedocs.io](https://your-project-name.readthedocs.io/).*
### Creating releases
Creating new GitHub and PyPI releases is easy. The GitHub Actions workflow that comes with this repository will handle all of that for you.
All you need to do is follow the instructions in [RELEASE_PROCESS.md](./RELEASE_PROCESS.md).
## Projects using this template
Here is an incomplete list of some projects that started off with this template:
- [ai2-tango](https://github.com/allenai/tango)
- [cached-path](https://github.com/allenai/cached_path)
- [beaker-py](https://github.com/allenai/beaker-py)
- [gantry](https://github.com/allenai/beaker-gantry)
- [ip-bot](https://github.com/abe-101/ip-bot)
☝️ *Want your work featured here? Just open a pull request that adds the link.*
## FAQ
#### Should I use this template even if I don't want to publish my package?
Absolutely! If you don't want to publish your package, just delete the `docs/` directory and the `release` job in [`.github/workflows/main.yml`](https://github.com/allenai/python-package-template/blob/main/.github/workflows/main.yml).
## Contributing
If you find a bug :bug:, please open a [bug report](https://github.com/allenai/python-package-template/issues/new?assignees=&labels=bug&template=bug_report.md&title=).
If you have an idea for an improvement or new feature :rocket:, please open a [feature request](https://github.com/allenai/python-package-template/issues/new?assignees=&labels=Feature+request&template=feature_request.md&title=).
https://packaging.python.org/en/latest/tutorials/packaging-projects/
https://medium.com/analytics-vidhya/how-to-create-a-python-library-7d5aea80cc3f
## Build
1. Increment Version in pyproject.toml
2. Run 'python3 -m build'
3. Run 'python3 -m twine upload dist/*'
Raw data
{
"_id": null,
"home_page": "https://github.com/CEREBRUS-MAXIMUS/surfer-python",
"name": "surferai",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7.1",
"maintainer_email": null,
"keywords": null,
"author": "Me",
"author_email": "Jack Blair <jackblairing@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/0f/1c/e4fca48f28b721d753c02167c4d7fc78cd592d1329f7597ea416ac630db1/surferai-0.1.7.tar.gz",
"platform": null,
"description": "# python-package-template\n\nThis is a template repository for Python package projects.\n\n## In this README :point_down:\n\n- [Features](#features)\n- [Usage](#usage)\n - [Initial setup](#initial-setup)\n - [Creating releases](#creating-releases)\n- [Projects using this template](#projects-using-this-template)\n- [FAQ](#faq)\n- [Contributing](#contributing)\n\n## Features\n\nThis template repository comes with all of the boilerplate needed for:\n\n\u2699\ufe0f Robust (and free) CI with [GitHub Actions](https://github.com/features/actions):\n - Unit tests ran with [PyTest](https://docs.pytest.org) against multiple Python versions and operating systems.\n - Type checking with [mypy](https://github.com/python/mypy).\n - Linting with [ruff](https://astral.sh/ruff).\n - Formatting with [isort](https://pycqa.github.io/isort/) and [black](https://black.readthedocs.io/en/stable/).\n\n\ud83e\udd16 [Dependabot](https://github.blog/2020-06-01-keep-all-your-packages-up-to-date-with-dependabot/) configuration to keep your dependencies up-to-date.\n\n\ud83d\udcc4 Great looking API documentation built using [Sphinx](https://www.sphinx-doc.org/en/master/) (run `make docs` to preview).\n\n\ud83d\ude80 Automatic GitHub and PyPI releases. Just follow the steps in [`RELEASE_PROCESS.md`](./RELEASE_PROCESS.md) to trigger a new release.\n\n## Usage\n\n### Initial setup\n\n1. [Create a new repository](https://github.com/allenai/python-package-template/generate) from this template with the desired name of your project.\n\n *Your project name (i.e. the name of the repository) and the name of the corresponding Python package don't necessarily need to match, but you might want to check on [PyPI](https://pypi.org/) first to see if the package name you want is already taken.*\n\n2. Create a Python 3.8 or newer virtual environment.\n\n *If you're not sure how to create a suitable Python environment, the easiest way is using [Miniconda](https://docs.conda.io/en/latest/miniconda.html). On a Mac, for example, you can install Miniconda using [Homebrew](https://brew.sh/):*\n\n ```\n brew install miniconda\n ```\n\n *Then you can create and activate a new Python environment by running:*\n\n ```\n conda create -n my-package python=3.9\n conda activate my-package\n ```\n\n3. Now that you have a suitable Python environment, you're ready to personalize this repository. Just run:\n\n ```\n pip install -r setup-requirements.txt\n python scripts/personalize.py\n ```\n\n And then follow the prompts.\n\n :pencil: *NOTE: This script will overwrite the README in your repository.*\n\n4. Commit and push your changes, then make sure all GitHub Actions jobs pass.\n\n5. (Optional) If you plan on publishing your package to PyPI, add repository secrets for `PYPI_USERNAME` and `PYPI_PASSWORD`. To add these, go to \"Settings\" > \"Secrets\" > \"Actions\", and then click \"New repository secret\".\n\n *If you don't have PyPI account yet, you can [create one for free](https://pypi.org/account/register/).*\n\n6. (Optional) If you want to deploy your API docs to [readthedocs.org](https://readthedocs.org), go to the [readthedocs dashboard](https://readthedocs.org/dashboard/import/?) and import your new project.\n\n Then click on the \"Admin\" button, navigate to \"Automation Rules\" in the sidebar, click \"Add Rule\", and then enter the following fields:\n\n - **Description:** Publish new versions from tags\n - **Match:** Custom Match\n - **Custom match:** v[vV]\n - **Version:** Tag\n - **Action:** Activate version\n\n Then hit \"Save\".\n\n *After your first release, the docs will automatically be published to [your-project-name.readthedocs.io](https://your-project-name.readthedocs.io/).*\n\n### Creating releases\n\nCreating new GitHub and PyPI releases is easy. The GitHub Actions workflow that comes with this repository will handle all of that for you.\nAll you need to do is follow the instructions in [RELEASE_PROCESS.md](./RELEASE_PROCESS.md).\n\n## Projects using this template\n\nHere is an incomplete list of some projects that started off with this template:\n\n- [ai2-tango](https://github.com/allenai/tango)\n- [cached-path](https://github.com/allenai/cached_path)\n- [beaker-py](https://github.com/allenai/beaker-py)\n- [gantry](https://github.com/allenai/beaker-gantry)\n- [ip-bot](https://github.com/abe-101/ip-bot)\n\n\u261d\ufe0f *Want your work featured here? Just open a pull request that adds the link.*\n\n## FAQ\n\n#### Should I use this template even if I don't want to publish my package?\n\nAbsolutely! If you don't want to publish your package, just delete the `docs/` directory and the `release` job in [`.github/workflows/main.yml`](https://github.com/allenai/python-package-template/blob/main/.github/workflows/main.yml).\n\n## Contributing\n\nIf you find a bug :bug:, please open a [bug report](https://github.com/allenai/python-package-template/issues/new?assignees=&labels=bug&template=bug_report.md&title=).\nIf you have an idea for an improvement or new feature :rocket:, please open a [feature request](https://github.com/allenai/python-package-template/issues/new?assignees=&labels=Feature+request&template=feature_request.md&title=).\n\n\nhttps://packaging.python.org/en/latest/tutorials/packaging-projects/\n\nhttps://medium.com/analytics-vidhya/how-to-create-a-python-library-7d5aea80cc3f\n\n## Build\n1. Increment Version in pyproject.toml\n2. Run 'python3 -m build'\n3. Run 'python3 -m twine upload dist/*'\n\n\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 JackBlair87 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.",
"summary": "The official Python library for the Surfer HumanAPI",
"version": "0.1.7",
"project_urls": {
"Homepage": "https://github.com/CEREBRUS-MAXIMUS/surfer-python",
"Repository": "https://github.com/CEREBRUS-MAXIMUS/surfer-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6ff362a253a2bab8ff3fb01713d6a9b88dda6885b28efe54a2e2d541f1c169f5",
"md5": "e7d4047e49ce6294a235beeaa9031a7e",
"sha256": "2f2285374f3e7aeb348cfb52f36e868c319be997e993710519aa57027a115639"
},
"downloads": -1,
"filename": "surferai-0.1.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e7d4047e49ce6294a235beeaa9031a7e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.1",
"size": 8300,
"upload_time": "2024-06-24T23:25:34",
"upload_time_iso_8601": "2024-06-24T23:25:34.202391Z",
"url": "https://files.pythonhosted.org/packages/6f/f3/62a253a2bab8ff3fb01713d6a9b88dda6885b28efe54a2e2d541f1c169f5/surferai-0.1.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0f1ce4fca48f28b721d753c02167c4d7fc78cd592d1329f7597ea416ac630db1",
"md5": "fe89bec267381112f837bed2d726de7d",
"sha256": "29fba4e56ae840235faa1ec6b50b498749ae21395a38918d554124af258022c7"
},
"downloads": -1,
"filename": "surferai-0.1.7.tar.gz",
"has_sig": false,
"md5_digest": "fe89bec267381112f837bed2d726de7d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.1",
"size": 8705,
"upload_time": "2024-06-24T23:25:35",
"upload_time_iso_8601": "2024-06-24T23:25:35.948993Z",
"url": "https://files.pythonhosted.org/packages/0f/1c/e4fca48f28b721d753c02167c4d7fc78cd592d1329f7597ea416ac630db1/surferai-0.1.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-24 23:25:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CEREBRUS-MAXIMUS",
"github_project": "surfer-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "surferai"
}
