Skip to main content

Strip personal annotations from code before committing

Project description

GhostNotes

Version: 1.0.0 | Last Updated: April 12, 2026

A Git tool that strips tagged comments before committing.


Installation

pip install ghostnotes

Then initialize in any git repo:

cd your-project
ghostnotes init

What it does

GhostNotes lets you leave personal notes in your code using a tag (default: GN:). Before every commit, it automatically strips them out so they never reach your repository.

x = some_function() # GN: this breaks when input is negative, fix later

This comment line gets stripped before the commit so it looks like:

x = some_function()

Your local file stays untouched.


Commands

Command Description
ghostnotes init Initialize GhostNotes in the current project
ghostnotes status Show all GhostNotes in the current project
ghostnotes set-tag --tag <tag> Change the default comment tag
ghostnotes add-lang --ext <.ext> --symb <symbol> Add support for a new language
ghostnotes pull Git pull that safely strips and re-applies your ghostnotes

Supported Languages

Language Extension Comment Symbol
Python .py #
Java .java //
JavaScript .js //
TypeScript .ts //
C .c //
C++ .cpp //
C# .cs //
Go .go //
Rust .rs //
Swift .swift //
Kotlin .kt //
Ruby .rb #
Shell .sh #
YAML .yaml / .yml #
R .r #
PHP .php //
Lua .lua --
SQL .sql --
Scala .scala //
Dart .dart //
Zig .zig //
Perl .pl #
Elixir .ex #
Haskell .hs --

Need a language not listed? Add it with ghostnotes add-lang --ext <.ext> --symb <symbol>.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ghostnotes-1.0.1.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ghostnotes-1.0.1-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file ghostnotes-1.0.1.tar.gz.

File metadata

  • Download URL: ghostnotes-1.0.1.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for ghostnotes-1.0.1.tar.gz
Algorithm Hash digest
SHA256 ca632aa1d173eabc457734085643a956afc800635c57e1598671b86ada8441d5
MD5 61555d1351227c7de79eafaaece7e346
BLAKE2b-256 725860b61191dab33757b1003ec870c9abfecf855dc6c7453a3cc8677dae7242

See more details on using hashes here.

File details

Details for the file ghostnotes-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: ghostnotes-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for ghostnotes-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a1573cf780074ff6f3545952761f49c64d416665e34d35341547a7d534a9a2c7
MD5 556d0a11c8b11308f7dd3533dbe1fc7b
BLAKE2b-256 075e224539b2b53ddab68019ecdebac572ab0e29be7bbcd4fbb8d8037633c2b0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page