semvec/pypi-packages huggingface dataset:
chewycomptoolcore 0.1.1
Chewy compensation calculation tool core logic
Requires Python: <4.0,>=3.10

# Description

This Python package contains a combination of classes and methods to model, run analyses, visualize and generate reports about different real and potential employee compensation scenarios across the lifecycle of their relationship with the company - as new hires, throughout their tenure, and in the event that a retention proposal must be developed. While it does contain code and artifacts related to the use of its other resources in the context of complete, packaged apps -- whether as an executable, a hosted internal web apps, or even directly within Snowflake -- it can and should chiefly be imported and used as a library within other, separate, application packaging and distribution repositories.

## Boostrapping Instructions
1. Create a new repository in GitHub using this repo (cloudeng-python-template) as the starting template.
2. Make sure you have poetry installed
3. Make sure you have an Artifcatory API key handy (https://chewyinc.jfrog.io/ui/admin/artifactory/user_profile).  Run the following code once to set your config for poetry.  

This should only need to happen once, and not per repo.  If you have already configured this, you can skip this step.
```
poetry config http-basic.artifactory youremail@chewy.com "superlongtoken"
```

4. Run the following code (substitute your application name for myapp, vertical and repo name).

eg:
```
make init appname=chewtopia reponame=chewtopia-python vertical=plat
```
This will do the following:

* Rename the myapp package to whatever your app is actually called.
* Replace the ###PROJECT_NAME### and ###VERTICAL_NAME### stubs in various files

## Repo setup
Follow [this guide](https://chewyinc.atlassian.net/wiki/spaces/CE/pages/1639715181/Setting+up+a+new+GitHub+Repo+for+Deployment) for instructions on how to setup with:

* Repo permissions
* ECR
* Jenkins

## Development Instructions
### Use these instructions after initial bootsrapping on a new repo, or if you're brand new to an existing project that has already been bootstrapped.
1. Run the following code to install all of the packages and the pre-commit framework:
```
make dev
```

2. Write your code and replace this readme as necessary.
3. We populate a standard PR template in ~/.github/pull_request_template.md - change as you see fit.

## Other helpful Make commands

### flake8 and black
```
make lint
```

### pytest (+ coverage)
```
make test appname=chewtopia
```

### Exporting Requirements file
```
# production
make requirements

# dev
make requirements_dev
```

## Documentation:
* [Python Standards](https://chewyinc.atlassian.net/wiki/spaces/CE/pages/1646560629/Python+Standards+for+Platform+Engineering)
* [Pytest Standards](https://chewyinc.atlassian.net/wiki/spaces/CE/pages/1680442313/Python+Unit+Testing+with+pytest)