Skip to content

Community

Welcome to the Xeepy community! Whether you need help, want to contribute, or just want to connect with other users, you're in the right place.

Get Help

  • FAQ

    Find answers to common questions

  • GitHub Issues

    Report bugs or request features

  • :material-discord:{ .lg .middle } Discord

    Chat with the community

  • Stack Overflow

    Ask technical questions

Contribute

We welcome contributions of all kinds!

Ways to Contribute

  • 🐛 Report bugs - Found an issue? Open a GitHub issue
  • 💡 Suggest features - Have an idea? Start a discussion
  • 📖 Improve docs - Fix typos, add examples, clarify explanations
  • 🔧 Submit PRs - Fix bugs or implement features
  • 🌐 Translate - Help translate docs to other languages
  • 📣 Spread the word - Star us on GitHub, share on social media

Getting Started

# Clone the repo
git clone https://github.com/xeepy/xeepy.git
cd xeepy

# Create virtual environment
python -m venv .venv
source .venv/bin/activate

# Install dev dependencies
pip install -e ".[dev]"

# Install pre-commit hooks
pre-commit install

# Run tests
pytest

# Build docs locally
mkdocs serve

Contribution Guidelines

See our Contributing Guide for detailed information on:

  • Code style and formatting
  • Commit message conventions
  • Pull request process
  • Testing requirements

Code of Conduct

We are committed to providing a welcoming and inspiring community for all.

See our Code of Conduct for community standards.

In short:

  • ✅ Be respectful and inclusive
  • ✅ Accept constructive criticism gracefully
  • ✅ Focus on what's best for the community
  • ❌ No harassment, discrimination, or trolling
  • ❌ No spam or self-promotion

Showcase

Projects built with Xeepy:

Built something cool? Submit your project!

Maintainers

Maintainer Role
👤 @maintainer1 Lead Developer
👤 @maintainer2 Documentation
👤 @maintainer3 Community

Sponsors

Xeepy is free and open-source. If you find it valuable, consider supporting development:

Sponsors

Thank you to our generous sponsors:

  • 🥇 Gold: Your company here
  • 🥈 Silver: Your company here
  • 🥉 Bronze: Your company here

Stay Updated

Resources


Thank you for being part of the Xeepy community! 🙏