Metadata-Version: 2.5
Name: code-compass
Version: 0.2.0
Summary: DEPRECATED: replaced by ppicker (command: pp)
Author-email: Roman <roman-right@protonmail.com>
Requires-Python: >=3.10,<4
Description-Content-Type: text/markdown
Classifier: Development Status :: 7 - Inactive
Requires-Dist: cookiecutter>=2.1.1,<3.0.0
Requires-Dist: pyside6>=6.5.0,<7.0.0
Project-URL: Homepage, https://github.com/roman-right/ppicker
Project-URL: Migration, https://github.com/roman-right/ppicker/blob/main/docs/MIGRATION.md
Import-Name: code_compass

# Code Compass

> **Deprecated.** This package is being retired and replaced by
> [ppicker](https://pypi.org/project/ppicker/) (command `pp`): a much faster
> terminal picker built for i3/sway. Move your projects over with
> `code-compass migrate`. The `code-compass` name on PyPI will later be handed
> over to another project, so migrate while this release is still available.
> Details: [migration guide](https://github.com/roman-right/ppicker/blob/main/docs/MIGRATION.md).

![Screenshot](https://raw.githubusercontent.com/roman-right/ppicker/legacy/code-compass/assets/screenshot-1.png)

A simple and intuitive desktop application to manage your coding projects, built with Python and Qt (using PySide6).

## Features

* Organize projects into categories.
* Quickly access project information, such as project name, path, and last opened date.
* Easily add, create, delete, and run projects with built-in buttons.
* Customize your project's attributes like name, path, and category.
* Choose between different IDEs, such as PyCharm and Visual Studio Code.
* Tab-based navigation for easy access to different project categories.

## Installation

```shell
pip install code-compass
```

## Usage

```shell
code-compass
```

## Configuration

Code Compass uses a configuration file to store your preferences. The configuration file is located at `~/.config/code_compass/config.yaml`.

### Example

```yaml

# IDE commands to run when clicking the "Run" button.
ide_commands:
  - pycharm
  - code

# Default path to start browsing when adding or creating a new project.
projects_path: /home/username/Projects

# Cookiecutter template to use when creating a new project.
cookiecutter: https://github.com/roman-right/py-template

```

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

