/stickybisht.note

A lightweight, customizable sticky notes application built with Python and Tkinter.

Primary LanguagePythonMIT LicenseMIT

StickyBisht

A lightweight, customizable(still working) sticky notes application built with Python and Tkinter.

Project Structure

stickybisht/
├── LICENSE
├── README.md
├── pyproject.toml
├── src/
│   └── stickybisht/
│       ├── __init__.py
│       ├── __main__.py
│       └── stickybisht_notes.py
└── requirements.txt

Installation

pip install stickybisht

Usage

After installation, you can run the application in two ways:

  1. From command line:
stickybisht
  1. From Python:
from stickybisht import StickyNote
note = StickyNote()
note.run()

Dependencies

  • Python 3.8+
  • tkinter (usually comes with Python)

Development

  1. Clone the repository:
git clone https://github.com/kitparl/stickybisht
cd stickybisht
  1. Create and activate virtual environment:
python -m venv venv
source venv/bin/activate  # Linux/macOS
venv\Scripts\activate     # Windows
  1. Install in development mode:
pip install -e .

Contributing 🤝

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/your_username/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/your_username/AmazingFeature)
  5. Open a Pull Request

License

MIT License