{"id":20757121,"url":"https://github.com/coala/coala-quickstart","last_synced_at":"2025-04-30T14:11:33.924Z","repository":{"id":5378159,"uuid":"52889504","full_name":"coala/coala-quickstart","owner":"coala","description":"A tool that generates an initial coala config file for you!","archived":false,"fork":false,"pushed_at":"2022-06-17T06:46:03.000Z","size":329,"stargazers_count":48,"open_issues_count":87,"forks_count":76,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-03-30T16:46:45.950Z","etag":null,"topics":["coala","editorconfig","gitignore","multiprocessing","package-json"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/coala.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-03-01T15:55:10.000Z","updated_at":"2024-12-24T20:08:25.000Z","dependencies_parsed_at":"2022-09-01T23:40:38.117Z","dependency_job_id":null,"html_url":"https://github.com/coala/coala-quickstart","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coala%2Fcoala-quickstart","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coala%2Fcoala-quickstart/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coala%2Fcoala-quickstart/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coala%2Fcoala-quickstart/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coala","download_url":"https://codeload.github.com/coala/coala-quickstart/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251717645,"owners_count":21632333,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["coala","editorconfig","gitignore","multiprocessing","package-json"],"created_at":"2024-11-17T09:39:55.118Z","updated_at":"2025-04-30T14:11:33.864Z","avatar_url":"https://github.com/coala.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":".. image:: https://cloud.githubusercontent.com/assets/7521600/19196124/e6ea06dc-8cd1-11e6-84a8-c51c899a1f36.png\n\ncoala-quickstart: personalized coala setup for your project\n-----------------------------------------------------------\ncoala-quickstart is a tool that helps users to quickly get started\nwith coala. It can generate a ``.coafile`` (\n`coala \u003chttps://github.com/coala/coala\u003e`__'s configuration\nfile) that is tailored to your project. This supports projects in\nseveral languages, including popular languages such as C/C++, Python,\nJavaScript, CSS, Java.\n\nPlease note that you will want to manually adapt the configuration to\nyour needs!\n\n-----\n\n.. contents::\n    :local:\n    :depth: 1\n    :backlinks: none\n\n-----\n\n========\nFeatures\n========\n\n* Out-of-the-box support for projects using various\n  `popular languages \u003chttps://github.com/coala/bear-docs/blob/master/README.rst\u003e`__,\n  such as **C/C++**, **Python**, **Javascript**, **CSS**, **Java** and many\n  others with built-in check routines.\n* Automatic identification of relevant bears for your project\n  based on the languages used.\n* A clean and simple interface with a well defined flow.\n\n-----\n\n============\nInstallation\n============\n\nTo install the **latest stable version** run:\n\n.. code-block:: bash\n\n    $ pip3 install coala-quickstart\n\n|Stable|\n\nTo install the latest development version run:\n\n.. code-block:: bash\n\n    $ git clone https://github.com/coala/coala-quickstart\n    $ cd coala-quickstart\n    $ pip3 install . \n\nUse the ``-e`` tag to install ``coala-quickstart`` in the editable mode which\nwill allow you to make changes to the local repository and have them\ntake effect in ``coala-quickstart`` immediately. For that, use the last\ncommmand as:\n\n.. code-block:: bash\n\n    $ pip3 install -e .\n\n|PyPI| |Windows| |Linux|\n\n-----\n\n=====\nUsage\n=====\n\ncoala-quickstart is designed with ease of use and simplicity in mind. To get\nstarted, simply run:\n\n.. code-block:: bash\n\n    $ coala-quickstart\n\nThis should prompt you for the project directory. If you want to use the current\ndirectory, just press the return key and we'll be on our way!\n\nAt the end, you should have a file named ``.coafile`` generated at the root of your\nproject directory. This contains all the settings needed by coala to lint and\nfix your code.\n\nWhen this is done, simply fire up coala from your project's root directory:\n\n.. code-block:: bash\n\n    $ coala\n\nYou can also open the ``.coafile`` in your favorite editor and edit\nthe settings to suit your needs. Check out our `coafile specification \u003chttp://coala.readthedocs.io/en/latest/Users/coafile.html\u003e`__\nto learn more.\n\n-----\n\n=======\nSupport\n=======\n\nFeel free to contact us at our `Gitter channel \u003chttps://gitter.im/coala/coala\u003e`__, we'd be happy to help!\n\nYou can also drop an email at our\n`mailing list \u003chttps://github.com/coala/coala/wiki/Mailing-Lists\u003e`__.\n\n-----\n\n=======\nAuthors\n=======\n\ncoala-quickstart is maintained by a growing community. Please take a look at the\nmeta information in `setup.py \u003csetup.py\u003e`__ for the current maintainers.\n\n-----\n\n=======\nLicense\n=======\n\n|AGPL|\n\n.. |Windows| image:: https://img.shields.io/badge/platform-Windows-brightgreen.svg\n.. |Linux| image:: https://img.shields.io/badge/platform-Linux-brightgreen.svg\n.. |Stable| image:: https://img.shields.io/badge/latest%20stable-0.3.0-green.svg\n.. |PyPI| image:: https://img.shields.io/pypi/pyversions/coala-quickstart.svg\n   :target: https://pypi.python.org/pypi/coala-quickstart\n.. |Linux Build Status| image:: https://img.shields.io/circleci/project/coala/coala-quickstart/master.svg?label=linux%20build\n   :target: https://circleci.com/gh/coala/coala\n.. |Windows Build status| image:: https://img.shields.io/appveyor/ci/coala/coala/master.svg?label=windows%20build\n   :target: https://ci.appveyor.com/project/coala/coala/branch/master\n.. |Scrutinizer Code Quality| image:: https://img.shields.io/scrutinizer/g/coala-analyzer/coala.svg?label=scrutinizer%20quality\n   :target: https://scrutinizer-ci.com/g/coala-analyzer/coala/?branch=master\n.. |codecov.io| image:: https://img.shields.io/codecov/c/github/coala/coala/master.svg?label=branch%20coverage\n   :target: https://codecov.io/github/coala/coala?branch=master\n.. |Documentation Status| image:: https://readthedocs.org/projects/coala/badge/?version=latest\n   :target: http://coala.rtfd.org/\n.. |AGPL| image:: https://img.shields.io/github/license/coala/coala.svg\n   :target: https://www.gnu.org/licenses/agpl-3.0.html\n.. |Gitmate| image:: https://img.shields.io/badge/Gitmate-0%20issues-brightgreen.svg\n   :target: http://gitmate.com/\n.. |gitter| image:: https://badges.gitter.im/coala/coala.svg\n    :target: https://gitter.im/coala/coala\n    :alt: Chat on Gitter\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoala%2Fcoala-quickstart","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoala%2Fcoala-quickstart","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoala%2Fcoala-quickstart/lists"}