mkdocstrings
stripe
mkdocstrings | stripe | |
---|---|---|
9 | 8 | |
1,579 | 2,001 | |
2.5% | 1.2% | |
8.4 | 9.0 | |
1 day ago | 4 days ago | |
Python | Go | |
ISC License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
mkdocstrings
-
Starlite development updates January ’23
Mkdocs has the mkdocstrings plugin, offering limited automated API documentation capabilities. It is however nowhere near as capable as Sphinx' autodoc, missing granularity in its configuration, limited intersphinx-like cross-referencing support, and essential features like documentation of inherited members, or the ability to manually describe objects if needed.
-
what's a good documentation platform that you guys would recommend?
mkdocstrings works well, although it is not as powerful as the API documentation in Sphinx.
-
Stripe Open Sources Markdoc
Author of Materia for MkDocs here. MkDocstrings [1] implements automatic generation of reference documentation from sources. It's language-agnostic, actively maintained and currently supports Python [2] and Crystal [3]. It also integrates nicely with Material for MkDocs.
[1]: https://mkdocstrings.github.io/
- Mkdocstrings: Automatic Python documentation from sources, for MkDocs
- Technical documentation that just works
-
mkdocstrings: the "autodoc" plugin for MkDocs
Some time has passed since I first introduced mkdocstrings here on reddit. If you don't know what mkdocstrings is: it's the equivalent of the autodoc Sphinx extension, but for MkDocs, a Markdown static site generator. It works differently though, and supports multiple languages by design (not only Python). Someone actually wrote a very good handler for the Crystal language, and another user on GitHub recently expressed their interest for writing one for Go.
-
Python tutorials building large(r) projects
Write proper docstrings as you go along (every time you write a new class/method/function you can document what it’s doing as you’ll know why and what from the pattern you chose). Using a tool like mkdocstrings makes maintaining documentation for larger projects automatic.
-
[Project] mkgendocs - Generating documentation from Python docstrings for MkDocs
I learned of https://github.com/pawamoy/mkdocstrings recently. Is it similar ?
-
Python packages and plugins as namespace packages
A user of mkdocstrings wrote a Crystal handler for their own use-case. They asked on the Gitter channel if we could allow to load external handlers, so they don't have to fork the project and install the fork, but rather just install their lightweight package containing just the handler.
stripe
-
August Stripe Developer Digest
New API version released: Version 2022-08-01 of the Stripe API has been released along with major version upgrades to all official client libraries, namely Dotnet, Go, Java, PHP, Node, Python, and Ruby. Read more about breaking changes in the API upgrades section and how to upgrade.
-
Ask HN: How can I “reset” the way I approach building software?
All I can give is my experience (been coding professionally for maybe 12-15 years) but I never looked at patterns like you are for a LONG time. I had no choice but to code in a "simple, straightforward" style because I didn't know anything fancy. I just did everything the normal, dumb way.
That said, things often become complicated because you don't have the skills to keep them simple (for example, you draw the boundaries between your modules wrong, or you fail to abstract the right things, leading to tight coupling and information leaking). So it's pretty normal for your software to be a mess for the first decade or so.
You should just keep writing your project, and as you find as the developer certain things on it are harder than they should be / frustrating / take too long, that will indicate a problem. Then you can keep trying to refactor until you get it right. Writing bad software is how you learn to write good software.
You asked for an example and I just gave you a bunch of philosophy, so I'll give you at least one. It depends on your language and what you're doing but I use Go a lot, and I think Stripe is pretty good at keeping things straightforward https://github.com/stripe/stripe-go
-
Stripe Open Sources Markdoc
Unfortunately my experience has been different; I found that Stripe's Go doc doesn't match their API and while searching on it I found that someone else had mentioned that to their personnel over freenode 2 years ago.
So I raised an issue on GitHub[1] on Apr 9 and hasn't been attended to yet.
On a more serious note, Stripe's payment links doc seemed to imply that tax rates are automatically calculated if the tax rates are set(as we do with code when we pass the tax_id), But I found after couple of payments that tax aren't being charged, On conversing on Twitter with the payment links dev I came to realize that the required option was not there for me[2] and then after couple of hours with their support staff I was informed that the options was not available for India as 'Stripe Tax' is a separate product.
Overall, I'm happy with Stripe's tech; at least compared to the other options I have. But their docs have caused me some frustrations.
[1] https://github.com/stripe/stripe-go/issues/1447
[2] https://twitter.com/joshuaackerman/status/144759582096702259...
-
Explore Stripe Tax and the new webhooks dashboard
Stay compliant with updated KYC regulations: We’ve added future_requirements support to our Java, PHP, .NET, Go, and Node SDKs. This parameter enables developers to know account verification requirements and deadlines.
-
The Idempotency-Key HTTP Header Field
A nice feature of keeping the idempotency key separate from the payload is that a service like Stripe can build tools to help users with idempotency even if the user has no idea what an idempotency key is.
For example, take a look at stripe-go's implementation, which automatically tags a request with a key if the user didn't specify one:
https://github.com/stripe/stripe-go/blob/67034d2205c0240ade9...
This works for all mutating requests, and is useful because the built-in retry system will automatically reuse the same key that was generated. Users can get the benefits of idempotency without really having to understand very well what's going on under the hood.
I suppose you could still do that by munging each request body, but IMO it's a nice feature to make sure that requests are the same as what the user specified. Also note that in practice the implementations are probably not that wildly different under the hood — despite being in a header, Stripe's idempotency is still being handled by the same application stack which processes the payment (i.e. not a middle box or load balancer).
-
Scalable developer video production
Stripe has seven main client libraries — Ruby, PHP, Python, Node, .NET, Go, and Java — and we wanted to give junior developers a foundation of broadly applicable knowledge to help them in all of their Stripe development going forward.
-
🎥 New developer foundations videos for our client libraries
Thank you to our top open-source contributors this month: joeltaylor, ybiquitous, gogainda (stripe-ruby); masterjus (stripe-php); westy92, msternow (stripe-android); ees37 (stripe-go); Fonata (stripe-cli); rdsedmundo (stripe-node); hibariya (stripe-samples); risentveber, vinistock, jaredbeck, ryanwilsonperkin, anandvc, RyanBrushett, paracycle (sorbet).
-
Incident response tips from firefighters 👩🚒 and new dev foundations videos
Thank you to our top open-source contributors this month: merrickfox, bayandin (stripe-go); KaanOzkan, Morriar, RyanBrushett, sharpobject, paracycle, kddeisz (sorbet); hibariya, maeda-kazuya, (stripe-samples); jofftiquez (stripe-js).
What are some alternatives?
mkdocs-material - Documentation that simply works
telegraph
sphinx - The Sphinx documentation generator
paypal - Golang client for PayPal REST API
pydocstyle - docstring style checker
telegram-bot-api - Golang bindings for the Telegram Bot API
furo - A clean customizable documentation theme for Sphinx
go-webmoney - package for working with webmoney xml interfaces
cookietemple - A collection of best practice cookiecutter templates for all domains and languages with extensive Github support ⛺
spotify - Go library for the Spotify Web API
pydantic - Data validation using Python type hints
geo-golang - Go library to access geocoding and reverse geocoding APIs