Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kjappelbaum/yscrambler
https://github.com/kjappelbaum/yscrambler
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/kjappelbaum/yscrambler
- Owner: kjappelbaum
- License: mit
- Created: 2022-08-04T11:55:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-26T22:53:32.000Z (4 months ago)
- Last Synced: 2024-08-27T01:42:24.560Z (4 months ago)
- Language: Python
- Size: 22.5 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
yscrambler
Permutation test of the null hypothesis that there is no relationship between features and labels
## 💪 Getting Started
> TODO show in a very small amount of space the **MOST** useful thing your package can do.
Make it as short as possible! You have an entire set of docs for later.
### Command Line Interface
The yscrambler command line tool is automatically installed. It can
be used from the shell with the `--help` flag to show all subcommands:
```shell
$ yscrambler --help
```
> TODO show the most useful thing the CLI does! The CLI will have documentation auto-generated
by `sphinx`.
## 🚀 Installation
The most recent code and data can be installed directly from GitHub with:
```bash
$ pip install git+https://github.com/kjappelbaum/yscrambler.git
```
To install in development mode, use the following:
```bash
$ git clone git+https://github.com/kjappelbaum/yscrambler.git
$ cd yscrambler
$ pip install -e .
```
## 👐 Contributing
Contributions, whether filing an issue, making a pull request, or forking, are appreciated. See
[CONTRIBUTING.rst](https://github.com/kjappelbaum/yscrambler/blob/master/CONTRIBUTING.rst) for more information on getting involved.
## 👋 Attribution
### ⚖️ License
The code in this package is licensed under the MIT License.
### 🍪 Cookiecutter
This package was created with [@audreyfeldroy](https://github.com/audreyfeldroy)'s
[cookiecutter](https://github.com/cookiecutter/cookiecutter) package using [@cthoyt](https://github.com/cthoyt)'s
[cookiecutter-snekpack](https://github.com/cthoyt/cookiecutter-snekpack) template.
## 🛠️ For Developers
See developer instrutions
The final section of the README is for if you want to get involved by making a code contribution.
### ❓ Testing
After cloning the repository and installing `tox` with `pip install tox`, the unit tests in the `tests/` folder can be
run reproducibly with:
```shell
$ tox
```
Additionally, these tests are automatically re-run with each commit in a [GitHub Action](https://github.com/kjappelbaum/yscrambler/actions?query=workflow%3ATests).
### 📦 Making a Release
After installing the package in development mode and installing
`tox` with `pip install tox`, the commands for making a new release are contained within the `finish` environment
in `tox.ini`. Run the following from the shell:
```shell
$ tox -e finish
```
This script does the following:
1. Uses BumpVersion to switch the version number in the `setup.cfg` and
`src/yscrambler/version.py` to not have the `-dev` suffix
2. Packages the code in both a tar archive and a wheel
3. Uploads to PyPI using `twine`. Be sure to have a `.pypirc` file configured to avoid the need for manual input at this
step
4. Push to GitHub. You'll need to make a release going with the commit where the version was bumped.
5. Bump the version to the next patch. If you made big changes and want to bump the version by minor, you can
use `tox -e bumpversion minor` after.
# yscrambler