Metadata-Version: 2.4
Name: ciopen
Version: 0.1.2
Summary: Open CI pipelines from your current Git repository
Author-email: Mel Cadano <mel.cdn@outlook.ph>
License-Expression: MIT
Project-URL: Homepage, https://github.com/mel-cdn/ciopen
Project-URL: Repository, https://github.com/mel-cdn/ciopen
Project-URL: Issues, https://github.com/mel-cdn/ciopen/issues
Project-URL: Changelog, https://github.com/mel-cdn/ciopen/blob/main/CHANGELOG.md
Keywords: cli,ci,github-actions,devtools,automation
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Environment :: Console
Classifier: Topic :: Software Development :: Build Tools
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer>=0.12
Provides-Extra: dev
Requires-Dist: pytest==9.0.2; extra == "dev"
Requires-Dist: pytest-cov==7.0.0; extra == "dev"
Requires-Dist: pre-commit==4.5.1; extra == "dev"
Requires-Dist: conventional-pre-commit==4.4.0; extra == "dev"
Dynamic: license-file

# ciopen

![Python](https://img.shields.io/badge/python-3.11+-blue?logo=python&logoColor=yellow)
[![PyPI](https://img.shields.io/pypi/v/ciopen?logo=pypi&logoColor=blue)](https://pypi.org/project/ciopen/)
[![Build](https://github.com/mel-cdn/ciopen/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/mel-cdn/ciopen/actions/workflows/build.yml)

Quickly open CI pipelines from your Git repository.

`ciopen` lets you open your CI pipelines or repository pages straight from the terminal — works with GitHub, GitLab,
Bitbucket, Azure DevOps (and more coming soon!).

Check out the docs:

- [PyPI](https://pypi.org/project/ciopen/)
- [GitHub](https://github.com/mel-cdn/ciopen/)

---

## ⚡ Features

Open CI pipeline on your default browser:

```bash
$ ciopen
```

---

## 💻 Installation

### Requirements:

- Python >=3.11
- Git installed and available in your PATH

### Using `pip`

```bash
$ pip install ciopen
```

### Using pip (editable / dev mode)

```bash
$ git clone https://github.com/mel-cdn/ciopen.git
$ cd ciopen
$ pipenv shell                  # or activate your virtualenv
$ ./scripts/run-checks.sh       # Install all dependencies
```

---

## 🛠️ Usage Examples

Show helpful CLI documentation:

```bash
$ ciopen --help

Usage: ciopen [OPTIONS] COMMAND [ARGS]...

Quickly open CI pipelines from your Git repository.

╭─ Options ─────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --install-completion          Install completion for the current shell                                        │
│ --show-completion             Show completion for the current shell, to copy it or customize the installation.│
│ --help                        Show this message and exit                                                      │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ version   Show ciopen version                                                                                 │
│ info      Show ciopen information                                                                             │
│ doctor    Check if everything is set up right                                                                 │
│ provider  Show which CI provider is detected                                                                  │
│ repo      Open the main page of this repository                                                               │
│ pr        Open the pull requests page of this repository                                                      │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
```

Open your repository's main page:

```bash
$ ciopen repo

Opening https://github.com/mel-cdn/ciopen
```

Check if it's going to work with diagnostics:

```bash
$ ciopen doctor

ciopen 0.1.0
Running diagnostics...

✅ Git installed
✅ Inside a Git repository
✅ Remote origin found
✅ CI Provider detected

Environment details:

Provider                : GitHub
Repository slug         : mel-cdn/ciopen
Current branch          : main
Repository URL          : https://github.com/mel-cdn/ciopen
Pipeline URL            : https://github.com/mel-cdn/ciopen/actions
Pull Request URL        : https://github.com/mel-cdn/ciopen/pulls
```

---

## 💡 Notes

- Works with HTTPS and SSH Git remotes.
- Detects CI provider automatically.
- Can be extended with more CI providers easily.
- Designed for casual, fast CLI usage.

## 🔮 Future Plans

- Add support for custom CI/CD providers e.g. CircleCI, Jenkins, AWS CodeBuild, etc.
- JSON output for scripts and automation
- Auto-detect Git branch and multiple pipelines
- Additional CLI shortcuts for common CI/CD tasks

---

## 🤝 Contributing

`ciopen` is open for contributions!

All contributions are welcome — whether it’s new features, bug fixes, or improving docs.

1. Clone the repository: `git clone https://github.com/mel-cdn/ciopen.git`
2. Create a new branch: `git checkout -b my-new-feature`
3. Install dependencies: `./run-checks.sh`
4. Make your changes
5. Submit a pull request

---
Made with ❤️ for developers who love fast, terminal-first CI access.
