Skip to content

Commit

Permalink
renaming everything to oft-api
Browse files Browse the repository at this point in the history
  • Loading branch information
NodeJSmith committed Jun 13, 2024
1 parent a4fadbf commit 8906eaa
Show file tree
Hide file tree
Showing 38 changed files with 62 additions and 62 deletions.
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ You can contribute in many ways:

### Report Bugs

Report bugs at https://github.com/nodejsmith/otf/issues.
Report bugs at https://github.com/nodejsmith/otf-api/issues.

If you are reporting a bug, please include:

Expand All @@ -29,13 +29,13 @@ and "help wanted" is open to whoever wants to implement it.

### Write Documentation

otf could always use more documentation, whether as part of the
official otf docs, in docstrings, or even on the web in blog posts,
otf-api could always use more documentation, whether as part of the
official otf-api docs, in docstrings, or even on the web in blog posts,
articles, and such.

### Submit Feedback

The best way to send feedback is to file an issue at https://github.com/nodejsmith/otf/issues.
The best way to send feedback is to file an issue at https://github.com/nodejsmith/otf-api/issues.

If you are proposing a feature:

Expand All @@ -46,13 +46,13 @@ If you are proposing a feature:

## Get Started!

Ready to contribute? Here's how to set up `otf` for local development.
Ready to contribute? Here's how to set up `otf-api` for local development.

1. Fork the `otf` repo on GitHub.
1. Fork the `otf-api` repo on GitHub.
2. Clone your fork locally

```
$ git clone git@github.com:your_name_here/otf.git
$ git clone git@github.com:your_name_here/otf-api.git
```

3. Ensure [poetry](https://python-poetry.org/docs/) is installed.
Expand Down Expand Up @@ -96,7 +96,7 @@ Before you submit a pull request, check that it meets these guidelines:
your new functionality into a function with a docstring, and add the
feature to the list in README.md.
3. The pull request should work for Python 3.6, 3.7, 3.8, 3.9 and for PyPy. Check
https://github.com/nodejsmith/otf/actions
https://github.com/nodejsmith/otf-api/actions
and make sure that the tests pass for all supported Python versions.

## Tips```
Expand Down
12 changes: 6 additions & 6 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,33 @@

## Stable release

To install otf, run this command in your
To install otf-api, run this command in your
terminal:

``` console
pip install otf
pip install otf-api
```

This is the preferred method to install otf, as it will always install the most recent stable release.
This is the preferred method to install otf-api, as it will always install the most recent stable release.

If you don't have [pip][] installed, this [Python installation guide][]
can guide you through the process.

## From source

The source for otf can be downloaded from
The source for otf-api can be downloaded from
the [Github repo][].

You can either clone the public repository:

``` console
git clone git://github.com/nodejsmith/otf
git clone git://github.com/nodejsmith/otf-api
```

Or download the [tarball][]:

``` console
curl -OJL https://github.com/nodejsmith/otf/tarball/master
curl -OJL https://github.com/nodejsmith/otf-api/tarball/master
```

Once you have a copy of the source, you can install it with:
Expand Down
2 changes: 1 addition & 1 deletion docs/usage.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Usage

To use otf in a project
To use otf-api in a project

```
import otf
Expand Down
8 changes: 4 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
site_name: otf
repo_url: https://github.com/nodejsmith/otf
repo_name: otf
site_name: OrangeTheory API
repo_url: https://github.com/nodejsmith/otf-api
repo_name: otf-api
nav:
- home: index.md
- installation: installation.md
Expand Down Expand Up @@ -77,7 +77,7 @@ extra:
provider: mike
social:
- icon: fontawesome/brands/github
link: https://github.com/nodejsmith/otf
link: https://github.com/nodejsmith/otf-api
name: Github
- icon: material/email
link: "mailto:j.smith.git1@gmail.com"
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[tool.setuptools.packages.find]
where = ["src"]
include = ["otf*"]
include = ["otf_api*"]

[project]
name = "otf-api"
Expand Down
File renamed without changes.
16 changes: 8 additions & 8 deletions src/otf/api.py → src/otf_api/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,18 @@
from loguru import logger
from yarl import URL

from otf.classes_api import ClassesApi
from otf.dna_api import DnaApi
from otf.member_api import MemberApi
from otf.models.auth import User
from otf.performance_api import PerformanceApi
from otf.studio_api import StudiosApi
from otf_api.classes_api import ClassesApi
from otf_api.dna_api import DnaApi
from otf_api.member_api import MemberApi
from otf_api.models.auth import User
from otf_api.performance_api import PerformanceApi
from otf_api.studio_api import StudiosApi

if typing.TYPE_CHECKING:
from loguru import Logger

from otf.models.responses.member_detail import MemberDetail
from otf.models.responses.studio_detail import StudioDetail
from otf_api.models.responses.member_detail import MemberDetail
from otf_api.models.responses.studio_detail import StudioDetail

API_BASE_URL = "api.orangetheory.co"
API_IO_BASE_URL = "api.orangetheory.io"
Expand Down
4 changes: 2 additions & 2 deletions src/otf/classes_api.py → src/otf_api/classes_api.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import typing

from otf.models.responses.classes import OtfClassList
from otf_api.models.responses.classes import OtfClassList

if typing.TYPE_CHECKING:
from otf import Api
from otf_api import Api


class ClassesApi:
Expand Down
8 changes: 4 additions & 4 deletions src/otf/dna_api.py → src/otf_api/dna_api.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import typing
from math import ceil

from otf.models.responses.dna_hr_history import DnaHrHistory
from otf.models.responses.dna_max_hr import DnaMaxHr
from otf.models.responses.dna_telemetry import DnaTelemetry
from otf_api.models.responses.dna_hr_history import DnaHrHistory
from otf_api.models.responses.dna_max_hr import DnaMaxHr
from otf_api.models.responses.dna_telemetry import DnaTelemetry

if typing.TYPE_CHECKING:
from otf import Api
from otf_api import Api


class DnaApi:
Expand Down
6 changes: 3 additions & 3 deletions src/otf/member_api.py → src/otf_api/member_api.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import typing
from datetime import date

from otf.models.responses.enums import BookingStatus
from otf.models.responses.favorite_studios import FavoriteStudioList
from otf_api.models.responses.enums import BookingStatus
from otf_api.models.responses.favorite_studios import FavoriteStudioList

from .models import (
BookingList,
Expand All @@ -21,7 +21,7 @@
)

if typing.TYPE_CHECKING:
from otf import Api
from otf_api import Api


class MemberApi:
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion src/otf/models/auth.py → src/otf_api/models/auth.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
from pycognito import Cognito, TokenVerificationException
from pydantic import Field

from otf.models.base import OtfBaseModel
from otf_api.models.base import OtfBaseModel

CLIENT_ID = "65knvqta6p37efc2l3eh26pl5o" # from otlive
USER_POOL_ID = "us-east-1_dYDxUeyL1"
Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

from pydantic import Field

from otf.models.base import OtfBaseModel
from otf_api.models.base import OtfBaseModel

from .enums import BookingStatus, StudioStatus

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from pydantic import Field

from otf.models.base import OtfBaseModel
from otf_api.models.base import OtfBaseModel


class Year(OtfBaseModel):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

from pydantic import Field

from otf.models.base import OtfBaseModel
from otf_api.models.base import OtfBaseModel


class MetricEntry(OtfBaseModel):
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from datetime import datetime

from otf.models.base import OtfBaseModel
from otf_api.models.base import OtfBaseModel


class Address(OtfBaseModel):
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from pydantic import Field

from otf.models.base import OtfBaseModel
from otf_api.models.base import OtfBaseModel


class MaxHr(OtfBaseModel):
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from pydantic import Field

from otf.models.base import OtfBaseModel
from otf_api.models.base import OtfBaseModel


class MaxHr(OtfBaseModel):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

from pydantic import Field

from otf.models.base import OtfBaseModel
from otf_api.models.base import OtfBaseModel


class Zone(OtfBaseModel):
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

from pydantic import Field

from otf.models.base import OtfBaseModel
from otf_api.models.base import OtfBaseModel


class Location(OtfBaseModel):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

from pydantic import Field

from otf.models.base import OtfBaseModel
from otf_api.models.base import OtfBaseModel


class LatestAgreement(OtfBaseModel):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

from pydantic import Field

from otf.models.base import OtfBaseModel
from otf_api.models.base import OtfBaseModel


class Address(OtfBaseModel):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

from pydantic import Field

from otf.models.base import OtfBaseModel
from otf_api.models.base import OtfBaseModel


class MemberMembership(OtfBaseModel):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

from pydantic import Field

from otf.models.base import OtfBaseModel
from otf_api.models.base import OtfBaseModel


class Location(OtfBaseModel):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

from pydantic import Field

from otf.models.base import OtfBaseModel
from otf_api.models.base import OtfBaseModel


class WorkoutType(OtfBaseModel):
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from pydantic import Field

from otf.models.base import OtfBaseModel
from otf_api.models.base import OtfBaseModel


class ZoneTimeMinutes(OtfBaseModel):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

from pydantic import Field

from otf.models.base import OtfBaseModel
from otf_api.models.base import OtfBaseModel


class Country(OtfBaseModel):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

from pydantic import Field

from otf.models.base import OtfBaseModel
from otf_api.models.base import OtfBaseModel


class Currency(OtfBaseModel):
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from pydantic import Field

from otf.models.base import OtfBaseModel
from otf_api.models.base import OtfBaseModel


class TotalClasses(OtfBaseModel):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

from pydantic import Field, PrivateAttr

from otf.models.base import OtfBaseModel
from otf_api.models.base import OtfBaseModel


class WorkoutType(OtfBaseModel):
Expand Down
6 changes: 3 additions & 3 deletions src/otf/performance_api.py → src/otf_api/performance_api.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import typing

from otf.models.responses.performance_summary_detail import PerformanceSummaryDetail
from otf.models.responses.performance_summary_list import PerformanceSummaryList
from otf_api.models.responses.performance_summary_detail import PerformanceSummaryDetail
from otf_api.models.responses.performance_summary_list import PerformanceSummaryList

if typing.TYPE_CHECKING:
from otf import Api
from otf_api import Api


class PerformanceApi:
Expand Down
File renamed without changes.
4 changes: 2 additions & 2 deletions src/otf/studio_api.py → src/otf_api/studio_api.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import typing

from otf.models.responses.studio_detail import Pagination, StudioDetail, StudioDetailList
from otf_api.models.responses.studio_detail import Pagination, StudioDetail, StudioDetailList

if typing.TYPE_CHECKING:
from otf import Api
from otf_api import Api


class StudiosApi:
Expand Down
Loading

0 comments on commit 8906eaa

Please sign in to comment.