# ABJAX
[](https://img.shields.io/github/v/release/thomaspinder/ABJAX)
[](https://github.com/thomaspinder/ABJAX/actions/workflows/main.yml?query=branch%3Amain)
[](https://codecov.io/gh/thomaspinder/ABJAX)
[](https://img.shields.io/github/commit-activity/m/thomaspinder/ABJAX)
[](https://img.shields.io/github/license/thomaspinder/ABJAX)
AB testing with JAX
- **Github repository**: <https://github.com/thomaspinder/ABJAX/>
- **Documentation** <https://thomaspinder.github.io/ABJAX/>
## Getting started with your project
### 1. Create a New Repository
First, create a repository on GitHub with the same name as this project, and then run the following commands:
```bash
git init -b main
git add .
git commit -m "init commit"
git remote add origin git@github.com:thomaspinder/ABJAX.git
git push -u origin main
```
### 2. Set Up Your Development Environment
Then, install the environment and the pre-commit hooks with
```bash
make install
```
This will also generate your `uv.lock` file
### 3. Run the pre-commit hooks
Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:
```bash
uv run pre-commit run -a
```
### 4. Commit the changes
Lastly, commit the changes made by the two steps above to your repository.
```bash
git add .
git commit -m 'Fix formatting issues'
git push origin main
```
You are now ready to start development on your project!
The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.
To finalize the set-up for publishing to PyPI, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi).
For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github).
To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/codecov/).
## Releasing a new version
- Create an API Token on [PyPI](https://pypi.org/).
- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/thomaspinder/ABJAX/settings/secrets/actions/new).
- Create a [new release](https://github.com/thomaspinder/ABJAX/releases/new) on Github.
- Create a new tag in the form `*.*.*`.
For more details, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/cicd/#how-to-trigger-a-release).
---
Repository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv).
Raw data
{
"_id": null,
"home_page": null,
"name": "abjax",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "ab-testing, cuped, jax, statistics, variance-reduction",
"author": "ABJAX Team",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/3a/c6/2de412fff441fa462bcb6319fac92dbc203d28f23f01a0bf78434afd27e6/abjax-0.0.1.tar.gz",
"platform": null,
"description": "# ABJAX\n\n[](https://img.shields.io/github/v/release/thomaspinder/ABJAX)\n[](https://github.com/thomaspinder/ABJAX/actions/workflows/main.yml?query=branch%3Amain)\n[](https://codecov.io/gh/thomaspinder/ABJAX)\n[](https://img.shields.io/github/commit-activity/m/thomaspinder/ABJAX)\n[](https://img.shields.io/github/license/thomaspinder/ABJAX)\n\nAB testing with JAX\n\n- **Github repository**: <https://github.com/thomaspinder/ABJAX/>\n- **Documentation** <https://thomaspinder.github.io/ABJAX/>\n\n## Getting started with your project\n\n### 1. Create a New Repository\n\nFirst, create a repository on GitHub with the same name as this project, and then run the following commands:\n\n```bash\ngit init -b main\ngit add .\ngit commit -m \"init commit\"\ngit remote add origin git@github.com:thomaspinder/ABJAX.git\ngit push -u origin main\n```\n\n### 2. Set Up Your Development Environment\n\nThen, install the environment and the pre-commit hooks with\n\n```bash\nmake install\n```\n\nThis will also generate your `uv.lock` file\n\n### 3. Run the pre-commit hooks\n\nInitially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:\n\n```bash\nuv run pre-commit run -a\n```\n\n### 4. Commit the changes\n\nLastly, commit the changes made by the two steps above to your repository.\n\n```bash\ngit add .\ngit commit -m 'Fix formatting issues'\ngit push origin main\n```\n\nYou are now ready to start development on your project!\nThe CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.\n\nTo finalize the set-up for publishing to PyPI, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi).\nFor activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github).\nTo enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/codecov/).\n\n## Releasing a new version\n\n- Create an API Token on [PyPI](https://pypi.org/).\n- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/thomaspinder/ABJAX/settings/secrets/actions/new).\n- Create a [new release](https://github.com/thomaspinder/ABJAX/releases/new) on Github.\n- Create a new tag in the form `*.*.*`.\n\nFor more details, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/cicd/#how-to-trigger-a-release).\n\n---\n\nRepository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv).\n",
"bugtrack_url": null,
"license": null,
"summary": "High-performance Python library for AB testing analysis with JAX and FastAPI",
"version": "0.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/your-org/abjax/issues",
"Documentation": "https://abjax.readthedocs.io",
"Homepage": "https://github.com/your-org/abjax",
"Repository": "https://github.com/your-org/abjax"
},
"split_keywords": [
"ab-testing",
" cuped",
" jax",
" statistics",
" variance-reduction"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "51b4ce16dc521a6ad1b73ecb492e8ec6597a473b84d13272b94459010f7047c8",
"md5": "1f0e2837db5b398e48fd0de2ca458b7e",
"sha256": "1a2321edf339f0f33b07608d2860322de076504156b3c2c44b8e406c3cf572cb"
},
"downloads": -1,
"filename": "abjax-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1f0e2837db5b398e48fd0de2ca458b7e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 17177,
"upload_time": "2025-08-02T05:39:58",
"upload_time_iso_8601": "2025-08-02T05:39:58.683565Z",
"url": "https://files.pythonhosted.org/packages/51/b4/ce16dc521a6ad1b73ecb492e8ec6597a473b84d13272b94459010f7047c8/abjax-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3ac62de412fff441fa462bcb6319fac92dbc203d28f23f01a0bf78434afd27e6",
"md5": "4598c27cfaff4c7c54f4f4ecbb4ace1b",
"sha256": "6334a41d7836df4e75a1fa92f1a4a044e32b568d6bad8a14303baf5bc4baccf1"
},
"downloads": -1,
"filename": "abjax-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "4598c27cfaff4c7c54f4f4ecbb4ace1b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 25846,
"upload_time": "2025-08-02T05:40:00",
"upload_time_iso_8601": "2025-08-02T05:40:00.156219Z",
"url": "https://files.pythonhosted.org/packages/3a/c6/2de412fff441fa462bcb6319fac92dbc203d28f23f01a0bf78434afd27e6/abjax-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-02 05:40:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "your-org",
"github_project": "abjax",
"github_not_found": true,
"lcname": "abjax"
}
JSON
