├── debian ├── compat ├── copyright ├── rules └── control ├── src ├── __init__.py ├── errors.py ├── main.py ├── config.py └── llm_service.py ├── tests ├── __init__.py └── main_test.py ├── version.txt ├── requirements.txt ├── .vscode └── settings.json ├── default_config.yml ├── LICENSE ├── README.md ├── Formula └── shelly.rb ├── .github └── workflows │ ├── update-homebrew-formula.yml │ └── update-debian-package.yml ├── shelly.sh └── .gitignore /debian/compat: -------------------------------------------------------------------------------- 1 | 11 -------------------------------------------------------------------------------- /src/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /version.txt: -------------------------------------------------------------------------------- 1 | 0.1.4 -------------------------------------------------------------------------------- /debian/copyright: -------------------------------------------------------------------------------- 1 | Files: * 2 | Copyright: 2024, Rumen Paletov 3 | License: MIT 4 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | certifi==2023.11.17 2 | charset-normalizer==3.3.2 3 | idna==3.6 4 | python-dotenv==1.0.0 5 | PyYAML==6.0.1 6 | requests==2.31.0 7 | urllib3==2.1.0 8 | -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "[python]": { 3 | "editor.defaultFormatter": "ms-python.black-formatter" 4 | }, 5 | "python.formatting.provider": "none" 6 | } -------------------------------------------------------------------------------- /default_config.yml: -------------------------------------------------------------------------------- 1 | EDITOR: nano 2 | OPENAI_API_KEY: '' 3 | OPENAI_MODEL_NAME: 'gpt-4' 4 | OPENAI_COMPLETIONS_ENDPOINT_URL: 'https://api.openai.com/v1/chat/completions' 5 | -------------------------------------------------------------------------------- /src/errors.py: -------------------------------------------------------------------------------- 1 | def auth_error_message(error): 2 | return f""" 3 | {str(error)} 4 | 5 | Your OPENAI_API_KEY is not working! 6 | Please set it in 'shelly --config'. 7 | """ 8 | -------------------------------------------------------------------------------- /debian/rules: -------------------------------------------------------------------------------- 1 | #!/usr/bin/make -f 2 | 3 | %: 4 | dh $@ --with python-virtualenv 5 | 6 | override_dh_virtualenv: 7 | dh_virtualenv --setuptools --requirements ../requirements.txt 8 | -------------------------------------------------------------------------------- /debian/control: -------------------------------------------------------------------------------- 1 | Source: shelly 2 | Section: python 3 | Priority: optional 4 | Maintainer: Rumen Paletov 5 | Build-Depends: debhelper (>= 11), dh-virtualenv, python3, python3-setuptools 6 | Standards-Version: 4.5.0 7 | X-Python3-Version: >= 3.5 8 | 9 | Package: shelly 10 | Architecture: all 11 | Depends: ${misc:Depends}, ${python3:Depends} 12 | Description: English to command (AI terminal assistant) 13 | -------------------------------------------------------------------------------- /src/main.py: -------------------------------------------------------------------------------- 1 | import os, sys 2 | import json 3 | from src.config import Config 4 | from src.llm_service import LLMService 5 | 6 | 7 | def make_output(generated_commands, config): 8 | return f"{config.get('USER_PROMPT')}{os.linesep}{generated_commands}" 9 | 10 | 11 | def generate_response(user_prompt, config): 12 | llm = LLMService(config) 13 | response = {"input": user_prompt} 14 | 15 | try: 16 | generated_commands = llm.request_completion(user_prompt) 17 | response["output"] = make_output(generated_commands, config) 18 | except Exception as e: 19 | response["error"] = str(e) 20 | 21 | return response 22 | 23 | 24 | if __name__ == "__main__": 25 | if len(sys.argv) != 2: 26 | sys.exit(1) 27 | 28 | user_prompt = sys.argv[1] 29 | response = generate_response(user_prompt, config=Config()) 30 | print(json.dumps(response)) 31 | -------------------------------------------------------------------------------- /src/config.py: -------------------------------------------------------------------------------- 1 | import os 2 | import yaml 3 | from dotenv import load_dotenv 4 | 5 | load_dotenv() 6 | 7 | SYSTEM_PARAMS = { 8 | "USER_PROMPT": "# These commands will be executed upon closing the file. Edit accordingly." 9 | } 10 | 11 | 12 | class Config: 13 | def __init__(self, config_filepath=None, enable_env=True): 14 | if config_filepath is None: 15 | USER_DATA_DIR = os.path.join(os.getenv("HOME"), ".shelly") 16 | with open(os.path.join(USER_DATA_DIR, "config.yml"), "r") as f: 17 | self.config = yaml.safe_load(f) 18 | else: 19 | with open(config_filepath, "r") as config_file: 20 | self.config = yaml.safe_load(config_file) 21 | self.enable_env = enable_env 22 | 23 | def get(self, param_name): 24 | if self.enable_env: 25 | value = os.getenv(param_name) 26 | if value is not None: 27 | return value 28 | if param_name in SYSTEM_PARAMS: 29 | return SYSTEM_PARAMS[param_name] 30 | return self.config[param_name] 31 | -------------------------------------------------------------------------------- /tests/main_test.py: -------------------------------------------------------------------------------- 1 | import os, sys 2 | 3 | _PARENT_DIR_PATH = os.path.abspath(os.path.join(os.path.dirname(__file__), "..")) 4 | sys.path.insert(0, _PARENT_DIR_PATH) 5 | 6 | import unittest 7 | from src.main import generate_response, make_output 8 | from src.config import Config 9 | 10 | 11 | class TestMainFunctions(unittest.TestCase): 12 | def test_generate_response(self): 13 | config = Config(os.path.join(_PARENT_DIR_PATH, "default_config.yml")) 14 | 15 | input = "git history" 16 | expected_output = { 17 | "input": input, 18 | "output": make_output("git log", config), 19 | } 20 | 21 | response = generate_response(input, config) 22 | self.assertEqual(response, expected_output) 23 | 24 | def test_wrong_openai_api_key(self): 25 | config = Config(os.path.join(_PARENT_DIR_PATH, "default_config.yml"), enable_env=False) 26 | 27 | input = "git history" 28 | response = generate_response(input, config) 29 | 30 | self.assertTrue('error' in response) 31 | 32 | 33 | if __name__ == "__main__": 34 | unittest.main() 35 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2024 Rumen Paletov 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Shelly: Write Terminal Commands in English 2 | 3 | Shelly is a powerful tool that translates English into commands that can be seamlessly executed in your terminal. You won't have to remember exact commands anymore. 4 | 5 | ## How It Works 6 | 7 | Upon calling shelly with an instruction, it opens an editor like nano/vim in the terminal with the proposed command. Saving executes the final version. 8 | 9 | Shelly uses AI to interpret plain English and translate it into accurate terminal commands. In particular, shelly uses OpenAI's GPT-4, so you'll need an OpenAI API Key. 10 | 11 | ## Usage Examples 12 | 13 | ```bash 14 | shelly 'git last 5 commits' 15 | $ "git log -5" 16 | 17 | shelly 'check size of files in this directory but format it with gb/mb, etc' 18 | $ "du -sh *" 19 | 20 | shelly 'find "class" in files in this directory without the .venv dir' 21 | $ grep -r --exclude-dir=.venv "class" . 22 | ``` 23 | 24 | ## Installation 25 | 26 | Install Shelly via Homebrew: 27 | 28 | ```bash 29 | brew untap naskovai/shelly 30 | brew tap naskovai/shelly https://github.com/naskovai/shelly 31 | brew install shelly 32 | ``` 33 | 34 | Enjoy using Shelly! 35 | -------------------------------------------------------------------------------- /Formula/shelly.rb: -------------------------------------------------------------------------------- 1 | class Shelly < Formula 2 | desc "Shelly translates English instructions to terminal commands." 3 | homepage "https://github.com/paletov/shelly" 4 | url "https://github.com/paletov/shelly/archive/refs/tags/v0.1.7.tar.gz" 5 | sha256 "a09749bc48194f3c2ad169f2da613cb7b84d526717a20957ff5515f1fe334378" 6 | version File.read(File.expand_path("../version.txt", __dir__)).strip 7 | 8 | depends_on "python@3" 9 | depends_on "sqlite" 10 | 11 | def install 12 | # Install Python dependencies from requirements.txt into libexec 13 | system "pip3", "install", "-r", "requirements.txt", "--target=#{libexec}", "--upgrade" 14 | 15 | # Install all files into a subdirectory of libexec 16 | libexec.install Dir["*"] 17 | 18 | # Create a symlink in the bin directory to the shelly.sh script 19 | (bin/"shelly").write_env_script(libexec/"shelly.sh", PYTHONPATH: libexec) 20 | end 21 | 22 | def caveats 23 | <<~EOS 24 | Note: Uninstalling Shelly does not automatically remove the '~/.shelly' directory, 25 | which may contain configuration files and user data. If you wish to completely remove all 26 | traces of Shelly, please delete this directory manually. 27 | EOS 28 | end 29 | 30 | test do 31 | # Replace this with a command that proves the tool was installed correctly 32 | system "#{bin}/shelly", "--version" 33 | end 34 | end 35 | -------------------------------------------------------------------------------- /src/llm_service.py: -------------------------------------------------------------------------------- 1 | import requests 2 | from src.errors import auth_error_message 3 | 4 | _SYSTEM_PROMPT = ( 5 | "You write unix commands. Output only commands. Just commands and nothing else." 6 | ) 7 | 8 | 9 | class LLMService: 10 | def __init__(self, config): 11 | self.config = config 12 | self.url = config.get("OPENAI_COMPLETIONS_ENDPOINT_URL") 13 | self.headers = { 14 | "Authorization": f"Bearer {config.get('OPENAI_API_KEY')}", 15 | "Content-Type": "application/json", 16 | } 17 | 18 | def request_completion(self, prompt): 19 | request_data = { 20 | "model": self.config.get("OPENAI_MODEL_NAME"), 21 | "messages": [ 22 | { 23 | "role": "system", 24 | "content": _SYSTEM_PROMPT, 25 | }, 26 | {"role": "user", "content": prompt}, 27 | ], 28 | "temperature": 0.01, 29 | } 30 | response = requests.post(self.url, json=request_data, headers=self.headers) 31 | self._handle_errors(response) 32 | return response.json()["choices"][0]["message"]["content"] 33 | 34 | def _handle_errors(self, response): 35 | if response.status_code == 401: 36 | message = response.json()['error']['message'] 37 | raise Exception(auth_error_message(message)) 38 | -------------------------------------------------------------------------------- /.github/workflows/update-homebrew-formula.yml: -------------------------------------------------------------------------------- 1 | name: Update Homebrew Formula 2 | 3 | on: 4 | release: 5 | types: [published] 6 | 7 | jobs: 8 | update-formula: 9 | runs-on: ubuntu-latest 10 | steps: 11 | - name: Checkout 12 | uses: actions/checkout@v2 13 | with: 14 | ref: main 15 | 16 | - name: Set up Ruby 17 | uses: ruby/setup-ruby@v1 18 | with: 19 | ruby-version: '3.0' # Check for the Ruby version required by Homebrew 20 | 21 | - name: Download release 22 | run: | 23 | wget -O release.tar.gz "https://github.com/${{ github.repository }}/archive/${{ github.ref }}.tar.gz" 24 | 25 | - name: Calculate SHA256 26 | id: sha 27 | run: | 28 | echo "::set-output name=sha::$(sha256sum release.tar.gz | awk '{print $1}')" 29 | 30 | - name: Update formula 31 | run: | 32 | FORMULA_FILE=Formula/shelly.rb 33 | NEW_URL="https://github.com/${{ github.repository }}/archive/${{ github.ref }}.tar.gz" 34 | sed -i -e "s|url \".*\"|url \"$NEW_URL\"|g" $FORMULA_FILE 35 | sed -i "s|sha256 .*|sha256 \"${{ steps.sha.outputs.sha }}\"|" $FORMULA_FILE 36 | 37 | - name: Commit and push changes 38 | run: | 39 | git config --global user.name 'Rumen Paletov' 40 | git config --global user.email 'rumen.paletov@gmail.com' 41 | git add Formula/shelly.rb 42 | git commit -m "Update Homebrew formula for latest version." 43 | git push origin main 44 | env: 45 | GITHUB_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN_FOR_GITHUB_ACTIONS }} 46 | -------------------------------------------------------------------------------- /.github/workflows/update-debian-package.yml: -------------------------------------------------------------------------------- 1 | name: Publish to Ubuntu PPA 2 | 3 | on: 4 | release: 5 | types: [published] 6 | 7 | jobs: 8 | build-and-upload: 9 | runs-on: ubuntu-latest 10 | steps: 11 | - name: Checkout repository 12 | uses: actions/checkout@v2 13 | 14 | - name: Set up Environment 15 | run: | 16 | sudo apt-get update 17 | sudo apt-get install -y devscripts debhelper dput gnupg 18 | 19 | - name: Configure Git and GPG for Launchpad 20 | run: | 21 | git config --global user.email "rumen.paletov@gmail.com" 22 | git config --global user.name "Rumen Paletov" 23 | echo "${{ secrets.GPG_PRIVATE_KEY }}" | gpg --import 24 | echo "pinentry-mode loopback" >> ~/.gnupg/gpg.conf 25 | gpg --list-keys 26 | 27 | - name: Prepare Original Tarball and Update Changelog 28 | env: 29 | DEBFULLNAME: "Rumen Paletov" 30 | DEBEMAIL: "rumen.paletov@gmail.com" 31 | run: | 32 | VERSION=$(echo ${{ github.ref }} | sed 's/refs\/tags\///') 33 | ORIG_TARBALL="${{ github.repository }}_${VERSION}.orig.tar.gz" 34 | wget -O "$ORIG_TARBALL" "https://github.com/${{ github.repository }}/archive/${{ github.ref_name }}.tar.gz" 35 | tar zxvf "$ORIG_TARBALL" -C .. 36 | mv "../${{ github.repository }}-${VERSION}" "../${{ github.repository }}_${VERSION}.orig" 37 | 38 | dch -v "${VERSION}-1" "Release of ${VERSION}" 39 | dch -r "" 40 | debuild -S -sa 41 | 42 | - name: Sign Package 43 | env: 44 | GPG_KEY_ID: ${{ secrets.GPG_KEY_ID }} 45 | run: | 46 | debsign -k${{ secrets.GPG_KEY_ID }} ../${{ github.repository }}_${VERSION}-1_source.changes 47 | 48 | - name: Upload to PPA 49 | run: | 50 | dput ppa:${{ secrets.LAUNCHPAD_PPA }} ../${{ github.repository }}_${VERSION}-1_source.changes 51 | env: 52 | LAUNCHPAD_PPA: ${{ secrets.LAUNCHPAD_PPA }} 53 | LAUNCHPAD_USERNAME: ${{ secrets.LAUNCHPAD_USERNAME }} 54 | -------------------------------------------------------------------------------- /shelly.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | get_configured_editor() { 4 | local configfile=$1 5 | configured_editor=$(grep '^EDITOR:' "$configfile" | cut -d ':' -f2 | xargs) 6 | if [ -z "$configured_editor" ]; then 7 | configured_editor=${VISUAL:-${EDITOR:-nano}} 8 | fi 9 | echo $configured_editor 10 | } 11 | 12 | USER_DATA_DIR="$HOME/.shelly" 13 | 14 | DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" >/dev/null 2>&1 && pwd)" 15 | export PYTHONPATH="$DIR:$PYTHONPATH" 16 | 17 | # Check if no arguments are provided 18 | if [ $# -eq 0 ]; then 19 | echo "Usage:" 20 | echo 21 | echo "> shelly \"command description in natural language\"" 22 | echo "> shelly --config" 23 | echo "> shelly --version" 24 | exit 0 25 | fi 26 | 27 | # Check for --version argument 28 | if [[ "$1" == "--version" ]]; then 29 | VERSION=$(cat "$DIR/version.txt") 30 | echo $VERSION 31 | exit 0 32 | fi 33 | 34 | # Define the config file path 35 | configfile="$USER_DATA_DIR/config.yml" 36 | 37 | if [[ "$1" == "--config" ]] || [ ! -f "$configfile" ]; then 38 | # Define the config file path 39 | configfile="$HOME/.shelly/config.yml" 40 | configdir="$HOME/.shelly" 41 | 42 | # Check if the config directory exists, if not, create it 43 | if [ ! -d "$configdir" ]; then 44 | mkdir -p "$configdir" 45 | fi 46 | 47 | # Check if the config file exists, if not, copy the default config file 48 | if [ ! -f "$configfile" ]; then 49 | cp "$DIR/default_config.yml" "$configfile" 50 | fi 51 | 52 | # Open the config file in the default editor for editing 53 | editor=$(get_configured_editor "$configfile") 54 | $editor "$configfile" 55 | 56 | # Exit after editing the config file 57 | exit 0 58 | fi 59 | 60 | # Run the Python script and capture the output 61 | response=$(python3 $DIR/src/main.py "$@") 62 | 63 | # Use jq to parse the JSON and extract fields. 64 | error_message=$(echo "$response" | jq -r '.error') 65 | 66 | if [ -n "$error_message" ] && [ "$error_message" != "null" ]; then 67 | echo "$error_message" 68 | exit 1 69 | fi 70 | input=$(echo "$response" | jq -r '.input') 71 | output=$(echo "$response" | jq -r '.output') 72 | 73 | # Get the device name 74 | device_name=$(hostname) 75 | 76 | # SQLite database file 77 | dbfile="$USER_DATA_DIR/history.db" 78 | 79 | # Check if the database file exists, if not, create it and initialize the table 80 | if [ ! -f "$dbfile" ]; then 81 | sqlite3 "$dbfile" "CREATE TABLE history (timestamp DATETIME DEFAULT CURRENT_TIMESTAMP, device_name TEXT, query TEXT, command TEXT);" 82 | fi 83 | 84 | # Create a temporary file 85 | tempfile=$(mktemp) 86 | 87 | # Ensure the temporary file is deleted on exit 88 | trap "rm -f '$tempfile'" EXIT 89 | 90 | # Write the command to the temporary file 91 | echo "$output" >"$tempfile" 92 | 93 | editor=$(get_configured_editor "$configfile") 94 | $editor "$tempfile" 95 | 96 | # Read the possibly edited command back from the temporary file 97 | file_contents=$(cat "$tempfile") 98 | 99 | # If the command is not empty, execute it and save it to the SQLite database 100 | if [ -n "$file_contents" ]; then 101 | # Insert the executed command into the history table 102 | sqlite3 "$dbfile" "INSERT INTO history (device_name, query, command) VALUES ('$device_name', '$input', '$file_contents');" 103 | 104 | # Execute the command 105 | eval "$file_contents" 106 | 107 | # Delete commands older than 3 months 108 | sqlite3 "$dbfile" "DELETE FROM history WHERE timestamp < datetime('now', '-3 month');" 109 | else 110 | echo "No command to execute." 111 | fi 112 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | MANIFEST 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .nox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | *.py,cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | cover/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | .pybuilder/ 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | # For a library or package, you might want to ignore these files since the code is 87 | # intended to run in multiple environments; otherwise, check them in: 88 | # .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # poetry 98 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 99 | # This is especially recommended for binary packages to ensure reproducibility, and is more 100 | # commonly ignored for libraries. 101 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 102 | #poetry.lock 103 | 104 | # pdm 105 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 106 | #pdm.lock 107 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 108 | # in version control. 109 | # https://pdm.fming.dev/#use-with-ide 110 | .pdm.toml 111 | 112 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 113 | __pypackages__/ 114 | 115 | # Celery stuff 116 | celerybeat-schedule 117 | celerybeat.pid 118 | 119 | # SageMath parsed files 120 | *.sage.py 121 | 122 | # Environments 123 | .env 124 | .venv 125 | env/ 126 | venv/ 127 | ENV/ 128 | env.bak/ 129 | venv.bak/ 130 | 131 | # Spyder project settings 132 | .spyderproject 133 | .spyproject 134 | 135 | # Rope project settings 136 | .ropeproject 137 | 138 | # mkdocs documentation 139 | /site 140 | 141 | # mypy 142 | .mypy_cache/ 143 | .dmypy.json 144 | dmypy.json 145 | 146 | # Pyre type checker 147 | .pyre/ 148 | 149 | # pytype static type analyzer 150 | .pytype/ 151 | 152 | # Cython debug symbols 153 | cython_debug/ 154 | 155 | # PyCharm 156 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 157 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 158 | # and can be added to the global gitignore or merged into this file. For a more nuclear 159 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 160 | #.idea/ 161 | --------------------------------------------------------------------------------