-
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.
- Loading branch information
Showing
14 changed files
with
912 additions
and
420 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] |
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 |
---|---|---|
@@ -0,0 +1,82 @@ | ||
Metadata-Version: 2.1 | ||
Name: cased | ||
Version: 0.1.0 | ||
Summary: A CLI tool for managing deployments and branches | ||
Home-page: https://github.com/cased/csd | ||
Author: Cased | ||
Author-email: [email protected] | ||
Classifier: Programming Language :: Python :: 3 | ||
Classifier: License :: OSI Approved :: MIT License | ||
Classifier: Operating System :: OS Independent | ||
Requires-Python: >=3.7 | ||
Description-Content-Type: text/markdown | ||
Requires-Dist: click | ||
Requires-Dist: requests | ||
Requires-Dist: rich | ||
Requires-Dist: questionary | ||
Requires-Dist: python-dateutil | ||
Requires-Dist: inquirer | ||
Requires-Dist: PyYAML | ||
|
||
# Cased CLI | ||
|
||
## Overview | ||
|
||
Cased CLI is a powerful command-line interface tool designed to streamline deployment processes and manage branches efficiently. It provides an intuitive way to interact with the Cased system, offering functionalities such as user authentication, deployment management, and branch oversight. | ||
|
||
## Features | ||
|
||
- User authentication (login/logout) | ||
- View recent deployments | ||
- Display active branches | ||
- Interactive deployment process with branch and target selection | ||
- Comprehensive help system | ||
|
||
## Installation | ||
|
||
You can install the Cased CLI tool using pip: | ||
|
||
``` | ||
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: | ||
|
||
``` | ||
cased --help | ||
``` | ||
|
||
### Available Commands: | ||
|
||
- `cased login`: Log in to the Cased system | ||
- `cased logout`: Log out from the Cased system | ||
- `cased deployments`: View recent deployments | ||
- `cased branches`: View active branches | ||
- `cased deploy`: Deploy a branch to a target environment | ||
|
||
For more details on each command, use: | ||
|
||
``` | ||
cased COMMAND --help | ||
``` | ||
|
||
## Contact | ||
|
||
For any questions or support, please contact [email protected] |
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 |
---|---|---|
@@ -0,0 +1,16 @@ | ||
README.md | ||
setup.py | ||
cased/__init__.py | ||
cased/cli.py | ||
cased.egg-info/PKG-INFO | ||
cased.egg-info/SOURCES.txt | ||
cased.egg-info/dependency_links.txt | ||
cased.egg-info/entry_points.txt | ||
cased.egg-info/requires.txt | ||
cased.egg-info/top_level.txt | ||
cased/commands/__init__.py | ||
cased/commands/build.py | ||
cased/commands/deploy.py | ||
cased/commands/init.py | ||
cased/commands/login.py | ||
cased/commands/resources.py |
Empty file.
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 |
---|---|---|
@@ -0,0 +1,2 @@ | ||
[console_scripts] | ||
cased = cased.cli:cli |
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 |
---|---|---|
@@ -0,0 +1,7 @@ | ||
click | ||
requests | ||
rich | ||
questionary | ||
python-dateutil | ||
inquirer | ||
PyYAML |
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 |
---|---|---|
@@ -0,0 +1 @@ | ||
cased |
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
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.