diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index fccde92..0184b21 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -4,7 +4,15 @@ repos: hooks: - id: end-of-file-fixer - id: trailing-whitespace + exclude: | + (?x)^( + .*\.md + )$ - id: check-added-large-files + exclude: | + (?x)^( + img/demo.gif + )$ - repo: https://github.com/psf/black rev: 23.11.0 hooks: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e476e6c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +## Installation + +To install from source: +`pip install .` + +For an editable installation during development: +`pip install -e .` + + +## Development + +To install tools for development: +`pip install -e ".[dev]"` + +To enable `pre-commit` (included with development tools): +`pre-commit install --install-hooks` + +To run `pre-commit` manually: +`pre-commit run` + +To apply `pre-commit` to all files: +`pre-commit run --all-files` + +To run a specific `pre-commit` check (e.g. `black`): +`pre-commit run black` diff --git a/README.md b/README.md index 1fc3d1a..864e8f2 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,40 @@ -# Pixee CLI + + + + Pixee Logo + -This repository contains the implementation of the Pixee CLI. +# Pixee is your automated product security engineer -## Installation +*Pixee fixes vulnerabilities, hardens code, squashes bugs, and gives +engineers more time to focus on the work that counts.* + +The Pixee CLI brings the power of Pixee's [Codemodder framework](https://codemodder.io) to your local development environment. + +![Pixee CLI Demo](img/demo.gif) -To install from source: -`pip install .` +Learn more at https://pixee.ai! -For an editable installation during development: -`pip install -e .` +Get the most out of Pixee by installing the Pixeebot GitHub app at +https://app.pixee.ai. Or find us on [GitHub Marketplace](https://github.com/apps/pixeebot). +## Supported Systems: +* MacOS (using [homebrew](https://brew.sh)) +* Linux (coming soon!) + +## Installation -## Development +### MacOS (using homebrew) -To install tools for development: -`pip install -e ".[dev]"` +``` +brew tap pixee/pixee +brew install pixee +``` -To enable `pre-commit` (included with development tools): -`pre-commit install --install-hooks` +## Usage -To run `pre-commit` manually: -`pre-commit run` +After installation, run the `pixee` command to see instructions and options. -To apply `pre-commit` to all files: -`pre-commit run --all-files` -To run a specific `pre-commit` check (e.g. `black`): -`pre-commit run black` +## Contributing +See [CONTRIBUTING.md](CONTRIBUTING.md). diff --git a/img/dark_mode_logo.png b/img/dark_mode_logo.png new file mode 100644 index 0000000..edddd97 Binary files /dev/null and b/img/dark_mode_logo.png differ diff --git a/img/demo.gif b/img/demo.gif new file mode 100644 index 0000000..d74a5a1 Binary files /dev/null and b/img/demo.gif differ diff --git a/img/light_mode_logo.png b/img/light_mode_logo.png new file mode 100644 index 0000000..b8b0a30 Binary files /dev/null and b/img/light_mode_logo.png differ diff --git a/img/logo.png b/img/logo.png new file mode 100644 index 0000000..4e3af5d Binary files /dev/null and b/img/logo.png differ