Skip to content

Appendices

Additional reference materials and resources for Stichotrope.

Contents

  • Glossary: Definitions of terms used in Stichotrope documentation

Additional Resources

  • CppProfiler: C++ profiling library that inspired Stichotrope's design
  • cProfile: Python's built-in function-level profiler
  • line_profiler: Line-by-line profiling for Python
  • py-spy: Sampling profiler for Python
  • pyinstrument: Statistical profiler for Python

Documentation

Version History

v0.1.0-dev.1 (Current)

Phase 1: Infrastructure Foundation

  • ✅ Testing framework and performance baseline (Milestone 1.1)
  • ✅ CI/CD pipeline (Milestone 1.2)
  • ✅ PyPI packaging (Milestone 1.3)
  • ⏳ Documentation infrastructure (Milestone 1.4 - In Progress)

Upcoming Releases

v0.2.0 - Phase 2: Core Architecture & Features

  • Thread-safe architecture redesign
  • Configuration system (TOML)
  • Input validation and error handling
  • Repetition testing framework

v1.0.0 - Production Release

  • Complete documentation
  • Final validation
  • Production-ready release

License

Stichotrope is licensed under the GNU Affero General Public License v3.0 or later (AGPLv3+).

License Summary

  • ✅ Commercial use allowed
  • ✅ Modification allowed
  • ✅ Distribution allowed
  • ✅ Private use allowed
  • ⚠️ Network use requires source disclosure (AGPL requirement)
  • ⚠️ Must include license and copyright notice
  • ⚠️ Must disclose source code
  • ⚠️ Changes must be documented

For full license text, see the LICENSE file in the repository.

Contributing

Contributions are welcome! Please see the Developer Documentation for guidelines.

How to Contribute

  1. Fork the repository
  2. Create a feature branch from dev
  3. Make your changes following code quality standards
  4. Add tests for new functionality
  5. Update documentation
  6. Submit a pull request to dev

Code of Conduct

Please be respectful and constructive in all interactions. We aim to maintain a welcoming and inclusive community.

Support

Getting Help

Reporting Bugs

When reporting bugs, please include:

  • Python version
  • Stichotrope version
  • Operating system
  • Minimal code example reproducing the issue
  • Expected behavior
  • Actual behavior
  • Error messages or stack traces

Feature Requests

Feature requests are welcome! Please:

  • Check existing issues first
  • Describe the use case
  • Explain why the feature would be useful
  • Provide examples if possible

Acknowledgments

Stichotrope is inspired by CppProfiler and builds on the excellent work of the Python profiling community.

We acknowledge and appreciate the following profiling tools that have influenced Stichotrope's design:

  • cProfile: Python's standard library profiler
  • line_profiler: Line-by-line profiling
  • py-spy: Sampling profiler
  • pyinstrument: Statistical profiler
  • CppProfiler: C++ profiling library

Contact

  • Author: Eliott Jacopin
  • Email: eliott.jacopin@riken.jp
  • GitHub: @LittleCoinCoin