code-compass

Name	code-compass JSON
Version	0.1.2 JSON
	download
home_page
Summary
upload_time	2023-04-19 17:26:30
maintainer
docs_url	None
author	Roman
requires_python	>=3.10,<3.12
license
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Code Compass

![Screenshot](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.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "code-compass",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10,<3.12",
    "maintainer_email": "",
    "keywords": "",
    "author": "Roman",
    "author_email": "roman-right@protonmail.com",
    "download_url": "https://files.pythonhosted.org/packages/ac/b9/ab08ca09d8975bff3707a5615247556a540943770b75003b594c9f46c303/code_compass-0.1.2.tar.gz",
    "platform": null,
    "description": "# Code Compass\n\n![Screenshot](assets/screenshot-1.png)\n\nA simple and intuitive desktop application to manage your coding projects, built with Python and Qt (using PySide6).\n\n## Features\n\n* Organize projects into categories.\n* Quickly access project information, such as project name, path, and last opened date.\n* Easily add, create, delete, and run projects with built-in buttons.\n* Customize your project's attributes like name, path, and category.\n* Choose between different IDEs, such as PyCharm and Visual Studio Code.\n* Tab-based navigation for easy access to different project categories.\n\n## Installation\n\n```shell\npip install code-compass\n```\n\n## Usage\n\n```shell\ncode-compass\n```\n\n## Configuration\n\nCode Compass uses a configuration file to store your preferences. The configuration file is located at `~/.config/code_compass/config.yaml`.\n\n### Example\n\n```yaml\n\n# IDE commands to run when clicking the \"Run\" button.\nide_commands:\n  - pycharm\n  - code\n\n# Default path to start browsing when adding or creating a new project.\nprojects_path: /home/username/Projects\n\n# Cookiecutter template to use when creating a new project.\ncookiecutter: https://github.com/roman-right/py-template\n\n```\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "",
    "version": "0.1.2",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1c29a07ee200ef52e1f73ced8e4b5361e2cb3e5d4dd343d1a8a3c9e679704355",
                "md5": "83af27fb559eda1f2f229844f90282eb",
                "sha256": "9d5a76944d689d15cdb84ccc21b9977c81f4a92a2cce3b3227a6bfc7d1c942c4"
            },
            "downloads": -1,
            "filename": "code_compass-0.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "83af27fb559eda1f2f229844f90282eb",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10,<3.12",
            "size": 9751,
            "upload_time": "2023-04-19T17:26:27",
            "upload_time_iso_8601": "2023-04-19T17:26:27.572802Z",
            "url": "https://files.pythonhosted.org/packages/1c/29/a07ee200ef52e1f73ced8e4b5361e2cb3e5d4dd343d1a8a3c9e679704355/code_compass-0.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "acb9ab08ca09d8975bff3707a5615247556a540943770b75003b594c9f46c303",
                "md5": "06332854f8a93a4a0e26d584376b2917",
                "sha256": "5ce18e77bc975beeb8cd8b404f47a49d6962decde6dd45b9194cf6c4d384cc0d"
            },
            "downloads": -1,
            "filename": "code_compass-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "06332854f8a93a4a0e26d584376b2917",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10,<3.12",
            "size": 8472,
            "upload_time": "2023-04-19T17:26:30",
            "upload_time_iso_8601": "2023-04-19T17:26:30.380070Z",
            "url": "https://files.pythonhosted.org/packages/ac/b9/ab08ca09d8975bff3707a5615247556a540943770b75003b594c9f46c303/code_compass-0.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-04-19 17:26:30",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "code-compass"
}