Insiders¤
I develop open-source software, primarily Python tools and libraries. I do this full time: I earn my keep through sponsorship from individual users and companies, which is what makes these projects sustainable and gives you a chance to use them.
I follow a sponsorware release strategy: new features are at first exclusively available to sponsors. Read on to learn what sponsorships achieve, how to become a sponsor to get access to Insiders, and what's in it for you!
What is Insiders?¤
Insiders are private forks of my projects, hosted as private GitHub repositories. Almost1 all new features are developed as part of these forks, which means that they are immediately available to all eligible sponsors, as they are made members of these repositories.
Every feature is tied to a funding goal in monthly subscriptions. When a funding goal is hit, the features that are tied to it are merged back into the public projects and released for general availability, making them available to all users. Bugfixes are always released in tandem.
Sponsorships start as low as $10 a month.2
What sponsorships achieve¤
Sponsorships make these projects sustainable, as they buy the maintainers of these projects time – a very scarce resource – which is spent on the development of new features, bug fixing, stability improvement, issue triage and general support. The biggest bottleneck in Open Source is time.3
If you're unsure if you should sponsor my projects, check out the list of completed funding goals to learn whether you're already using features that were developed with the help of sponsorships. You're most likely using at least a handful of them, thanks to our awesome sponsors!
What's in it for me?¤
The moment you become a sponsor, you'll get immediate access to 18 additional features that you can start using right away, and which are currently exclusively available to sponsors:
- mkdocstrings/python — Relative cross-references
- mkdocstrings/python — Scoped cross-references
- mkdocstrings/griffe-public-redundant-aliases — [Project] Mark objects imported with redundant aliases as public
- mkdocstrings/griffe-public-wildcard-imports — [Project] Mark wildcard imported objects as public
- mkdocstrings/griffe-runtime-objects — [Project] Make runtime objects available through
extra
- mkdocstrings/griffe-autodocstringstyle — [Project] Set docstring style to
auto
for external packages - mkdocstrings/griffe-sphinx — [Project] Parse Sphinx-comments above attributes as docstrings
- mkdocstrings/griffe — Automatic detection of docstring style
- mkdocstrings/c — [Project] A C handler for mkdocstrings
- pawamoy/markdown-exec — Custom icons in tree fences
- pawamoy/mkdocs-pygments — [Project] Highlighting themes for code blocks
- mkdocstrings/typescript — [Project] A TypeScript handler for mkdocstrings
- mkdocstrings/griffe-typedoc — [Project] Signatures for entire TypeScript programs using TypeDoc
- mkdocstrings/python — Class inheritance diagrams with Mermaid
- mkdocstrings/python — Annotations modernization
- mkdocstrings/griffe — Expressions modernization
- mkdocstrings/griffe — Check API of Python packages from PyPI
- pawamoy/devboard — [Project] A development dashboard for your projects
mkdocstrings projects¤
mkdocstrings is a plugin for MkDocs, a static site generator written in Python. It brings autodoc capabilities to MkDocs, to enable automatic and configurable documentation of Python APIs.
-
Signatures for entire Python programs. Generate API documentation or find breaking changes in your API. -
Output API docs to Markdown using Griffe. -
mkdocstrings/griffe-autodocstringstyle
Set docstring style toauto
for external packages. -
mkdocstrings/griffe-inherited-docstrings
Griffe extension for inheriting docstrings. -
mkdocstrings/griffe-public-redundant-aliases
Mark objects imported with redundant aliases as public. -
mkdocstrings/griffe-public-wildcard-imports
Mark wildcard imported objects as public. -
Griffe extension for Pydantic. -
mkdocstrings/griffe-runtime-objects
Make runtime objects available throughextra
. -
Parse Sphinx-comments above attributes as docstrings. -
A textual user interface for Griffe. -
Signatures for entire TypeScript programs using TypeDoc. -
mkdocstrings/griffe-warnings-deprecated
Griffe extension for@warnings.deprecated
(PEP 702). -
A C handler for mkdocstrings. -
A Python handler for mkdocstrings. -
A shell scripts/libraries handler for mkdocstrings. -
A TypeScript handler for mkdocstrings.
Other tools/libraries¤
These tools are focused on documentation, developer-experience and productivity.
-
A development dashboard for your projects. -
Manage your Insiders projects. -
Utilities to execute code blocks in Markdown files. -
Markdown extension to parsepycon
code blocks without indentation. -
MkDocs plugin to generate a manpage from the documentation site. -
Highlighting themes for code blocks. -
Self-hosted PyPI server with automatic updates for Insiders versions.
How to become a sponsor¤
Thanks for your interest in sponsoring! In order to become an eligible sponsor with your GitHub account, visit pawamoy's sponsor profile, and complete a sponsorship of $10 a month or more. You can use your individual or organization GitHub account for sponsoring.
Sponsorships lower than $10 a month are also very much appreciated! They won't grant you access to Insiders, but they will be counted towards reaching sponsorship goals. Every sponsor helps us implementing new features and releasing them to the public.
Important: If you're sponsoring @pawamoy through a GitHub organization, please send a short email to insiders@pawamoy.fr with the name of your organization and the GitHub account of the individual that should be added as a collaborator.4
You can cancel your sponsorship anytime.5
If you sponsor publicly, you're automatically added here with a link to your profile and avatar to show your support for my projects. Alternatively, if you wish to keep your sponsorship private, you'll be a silent +1. You can select visibility during checkout and change it afterwards.
Funding ¤
Goals¤
The following section lists all funding goals. Each goal contains a list of features prefixed with a checkmark symbol, denoting whether a feature is already available or planned, but not yet implemented. When the funding goal is hit, the features are released for general availability.
$ 1,500 — HyperLamp Navigation Tips¤
- mkdocstrings/griffe — Check API of Python packages from PyPI
- mkdocstrings/griffe — Expressions modernization
- mkdocstrings/griffe — Automatic detection of docstring style
- mkdocstrings/griffe-autodocstringstyle — [Project] Set docstring style to
auto
for external packages - mkdocstrings/griffe-public-redundant-aliases — [Project] Mark objects imported with redundant aliases as public
- mkdocstrings/griffe-public-wildcard-imports — [Project] Mark wildcard imported objects as public
- mkdocstrings/griffe-runtime-objects — [Project] Make runtime objects available through
extra
- mkdocstrings/griffe-sphinx — [Project] Parse Sphinx-comments above attributes as docstrings
- mkdocstrings/griffe-typedoc — [Project] Signatures for entire TypeScript programs using TypeDoc
- mkdocstrings/python — Class inheritance diagrams with Mermaid
- mkdocstrings/python — Annotations modernization
- pawamoy/devboard — [Project] A development dashboard for your projects
- pawamoy/markdown-exec — Custom icons in tree fences
- pawamoy/mkdocs-pygments — [Project] Highlighting themes for code blocks
$ 2,000 — FusionDrive Ejection Configuration¤
- mkdocstrings/c — [Project] A C handler for mkdocstrings
- mkdocstrings/python — Relative cross-references
- mkdocstrings/python — Scoped cross-references
- mkdocstrings/typescript — [Project] A TypeScript handler for mkdocstrings
Goals completed¤
This section lists all funding goals that were previously completed, which means that those features were part of Insiders, but are now generally available and can be used by all users.
$ 500 — PlasmaVac User Guide¤
- mkdocstrings/griffe2md — [Project] Output API docs to Markdown using Griffe
- mkdocstrings/griffe-inherited-docstrings — [Project] Griffe extension for inheriting docstrings
- mkdocstrings/python — Cross-references for type annotations in signatures
- mkdocstrings/python — Symbol types in headings and table of contents
- pawamoy/markdown-exec — Pyodide fence
- pawamoy/mkdocs-manpage — [Project] MkDocs plugin to generate a manpage from the documentation site
$ 1,000 — GraviFridge Fluid Renewal¤
- mkdocstrings/griffe — Markdown output format for the
griffe check
command - mkdocstrings/griffe — GitHub output format for the
griffe check
command - mkdocstrings/griffe-pydantic — [Project] Griffe extension for Pydantic
- mkdocstrings/griffe-tui — [Project] A textual user interface for Griffe
- mkdocstrings/griffe-warnings-deprecated — [Project] Griffe extension for
@warnings.deprecated
(PEP 702) - mkdocstrings/python — Auto-summary of object members
- mkdocstrings/python — Automatic rendering of function signature overloads
- mkdocstrings/python — Parameter headings
- mkdocstrings/python — Automatic cross-references to parameters
- mkdocstrings/python — Automatic cross-references for default parameter values in signatures
- mkdocstrings/shell — [Project] Shell scripts/libraries handler for mkdocstrings
- pawamoy/insiders-project — [Project] Manage your Insiders projects
- pawamoy/markdown-pycon — [Project] Markdown extension to parse
pycon
code blocks without indentation or fences - pawamoy/pypi-insiders — [Project] Self-hosted PyPI server with automatic updates for Insiders versions of projects
Frequently asked questions¤
Payment¤
We don't want to pay for sponsorship every month. Are there any other options?
Yes. You can sponsor on a yearly basis by switching your GitHub account to a yearly billing cycle. If for some reason you cannot do that, you could also create a dedicated GitHub account with a yearly billing cycle, which you only use for sponsoring (some sponsors already do that).
If you have any problems or further questions, please reach out to insiders@pawamoy.fr.
Terms¤
Are we allowed to use Insiders under the same terms and conditions as the public project?
Yes. Whether you're an individual or a company, you may use the Insiders versions precisely under the same terms as the public versions, which are generally given by the ISC License. However, we kindly ask you to respect our fair use policy:
-
Please don't distribute the source code of Insiders. You may freely use it for public, private or commercial projects, privately fork or mirror it, but please don't make the source code public, as it would counteract the sponsorware strategy.
-
If you cancel your subscription, you're automatically removed as a collaborator and will miss out on all future updates of Insiders. However, you may use the latest version that's available to you as long as you like. Just remember that GitHub deletes private forks.
-
In general, every new feature is first exclusively released to sponsors, but sometimes upstream dependencies enhance existing features that must be supported. ↩
-
Note that $10 a month is the minimum amount to become eligible for Insiders. While GitHub Sponsors also allows to sponsor lower amounts or one-time amounts, those can't be granted access to Insiders due to technical reasons. Such contributions are still very much welcome as they help ensuring the project's sustainability. ↩
-
Making an Open Source project sustainable is exceptionally hard: maintainers burn out, projects are abandoned. That's not great and very unpredictable. The sponsorware model ensures that if you decide to use my Insiders projects, you can be sure that bugs are fixed quickly and new features are added regularly. ↩
-
It's currently not possible to grant access to each member of an organization, as GitHub only allows for adding users. Thus, after sponsoring, please send an email to insiders@pawamoy.fr, stating which account should become a collaborator of the Insiders repository. We're working on a solution which will make access to organizations much simpler. To ensure that access is not tied to a particular individual GitHub account, create a bot account (i.e. a GitHub account that is not tied to a specific individual), and use this account for the sponsoring. After being added to the list of collaborators, the bot account can create a private fork of the private Insiders GitHub repository, and grant access to all members of the organizations. ↩
-
If you cancel your sponsorship, GitHub schedules a cancellation request which will become effective at the end of the billing cycle. This means that even though you cancel your sponsorship, you will keep your access to Insiders as long as your cancellation isn't effective. All charges are processed by GitHub through Stripe. As we don't receive any information regarding your payment, and GitHub doesn't offer refunds, sponsorships are non-refundable. ↩