-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6 from cased/poetry
Switch to Poetry
- Loading branch information
Showing
5 changed files
with
635 additions
and
52 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -22,19 +22,6 @@ pip install cased | |
|
||
This will install the latest version of the tool from PyPI. | ||
|
||
For development installation: | ||
|
||
1. Clone the repository: | ||
``` | ||
git clone https://github.com/cased/csd.git | ||
cd csd | ||
``` | ||
|
||
2. Install in editable mode: | ||
``` | ||
pip install -e . | ||
``` | ||
|
||
## Usage | ||
|
||
After installation, you can use the CLI tool by running `cased` followed by a command: | ||
|
@@ -57,6 +44,65 @@ For more details on each command, use: | |
cased COMMAND --help | ||
``` | ||
|
||
## Development | ||
|
||
To set up the Cased CLI for development: | ||
|
||
1. Clone the repository: | ||
``` | ||
git clone https://github.com/cased/cli.git | ||
cd cli | ||
``` | ||
|
||
2. Install Poetry (if not already installed): | ||
``` | ||
pip install poetry | ||
``` | ||
|
||
3. Install dependencies: | ||
``` | ||
poetry install | ||
``` | ||
|
||
4. Activate the virtual environment: | ||
``` | ||
poetry shell | ||
``` | ||
|
||
5. Run the CLI in development mode: | ||
``` | ||
poetry run cased | ||
``` | ||
|
||
### Making Changes | ||
|
||
1. Make your changes to the codebase. | ||
2. Update tests if necessary. | ||
3. Run tests: | ||
``` | ||
poetry run pytest | ||
``` | ||
4. Build the package: | ||
``` | ||
poetry build | ||
``` | ||
|
||
### Submitting Changes | ||
|
||
1. Create a new branch for your changes: | ||
``` | ||
git checkout -b feature/your-feature-name | ||
``` | ||
2. Commit your changes: | ||
``` | ||
git commit -am "Add your commit message" | ||
``` | ||
3. Push to your branch: | ||
``` | ||
git push origin feature/your-feature-name | ||
``` | ||
4. Create a pull request on GitHub. | ||
|
||
## Contact | ||
|
||
For any questions or support, please contact [email protected] |
Oops, something went wrong.