Python Cheatsheet
pdoc
Our great sponsors
Python Cheatsheet | pdoc | |
---|---|---|
36 | 10 | |
4,031 | 1,813 | |
- | 2.8% | |
9.3 | 8.2 | |
1 day ago | 6 days ago | |
Vue | Python | |
MIT License | The Unlicense |
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.
Python Cheatsheet
-
All-Inclusive Python Cheatsheet
It appears that it's not an actual "sheet"; but, a crowd-sourced book. From the GitHub page, if you click on https://www.pythoncheatsheet.org/ and scroll to the bottom of the page and click on "Contributing," you go to the page on how to contribute to the "book." Subsequent "pages," accessed from the lower right corner take you to "Basics" and Built-In Functions" and more. It's not a sheet,
- I'm about to start programming
- Cool Github repositories for Everyone
-
i had 19 days of time to learn basics of python
I like the site: www.pythoncheatsheet.org for people coming from a programming background that just want to go over the basics and easy things like "what is the syntax for a dictionary".
- Learning all built-in functions
-
Andrew Ng - a good place to start?
You can replace that udemy course with these: https://www.pythoncheatsheet.org/ https://www.gormanalysis.com/blog/python-numpy-for-your-grandma/ https://www.gormanalysis.com/blog/python-pandas-for-your-grandpa/ https://www.gormanalysis.com/blog/neural-networks-for-your-dog/
- Best online course to learn the basics of Python
-
Building a Tic Tac Toe Game in Python using PRIMM Approach
Trace each line of code and ensure that it functions as intended. You may explore how they function and learn more about the syntax by using python cheat sheet. You can also use trace table to trace the program and understand the conditions. Therefore, discuss each line of code and write a brief and concise comment about it.
- Looking for a Python3 Cheat Sheet recommendation!
-
I'm struggling to understand python
i always have to pull up a "cheat sheet" as i do my classwork. the one i've been using for python is https://www.pythoncheatsheet.org/ it clearly defines operators, data types, and is super helpful when starting out.
pdoc
-
How to Write Impeccably Clean Code That Will Save Your Sanity
You can also use doc-strings to generate automated documentation for your code using a library like pdoc. Consider the following example from Stack-Scraper and the corresponding documentation generated using pdoc library.
-
what's a good documentation platform that you guys would recommend?
I’ve used sphinx extensively and though it is one of the standards and does a ton, I do not like or recommend it. Personally, I realllly like pdoc for its simplicity. Do not confused pdoc with pdoc3
-
The Slow March of Progress in Programming Language Tooling
RE browser vs reading the code: sounds like you have a nicer setup than my neovim setup. Although I think my first point still holds unless CLion handles that case too.
With respect to the rest of your comment, indeed, those are issues. Although I think I take issue with you pinning this on rustdoc. I actually think it's a dance between documentation presentation (so, rustdoc), API design and familiarity with the language.
I've long said that rustdoc makes unknown unknowns difficult to discover, and this is particularly painful for folks new to Rust. Because you don't really know what to look for yet. And writing docs is a difficult exercise in perspective taking, where you need to balance what you think others know. If you assume they know too little, it's not hard to end up writing too much and adding a fair bit of noise. With that said, I agree that "too little docs" is a far more common problem than "too many docs."
But yeah, your experience is a perfect example of what I mean when I say "generics complicate APIs." They introduce indirection everywhere, and I'm not sure how much rustdoc can really help with that. You might be right that maybe there are some visualizations that can be added, but like you, I've always seen those as gimmicks in other tools that are rarely useful. IMO, a heavily generic API really requires the crate author to write more prose about how their APIs are intended to be used with lots of concrete examples.
The interesting bit here is that I've personally found the documentation experience in Rust to be far far better than any other ecosystem. All the way from writing docs up to consuming them. I've sampled many different ecosystems (C, C++, Haskell, Python, Go to name some) and other than maybe Go, I thought the doc experience was really just not great in any of them. Python specifically seems to be a case where I tend to see a lot of variance in opinion. I hated Sphinx so much, for example, that I built an alternative.[1] I also just generally dislike the output that Sphinx produces. I find that it lacks structure, and I've always had a hard time navigating my way through Python library docs.
[1]: https://github.com/mitmproxy/pdoc
-
What is it that makes Rust documentation so special, and how could we make that lightning strike twice in other languages?
Anyway, this is all my opinion. And a lot of it is based on reflecting on my own experience. I have no idea how well it generalizes. I have given this topic a lot of thought though, and have even written documentation generators for other ecosystems because I thought the other choices were bad enough to warrant spending a few weeks on such a tool.
-
Bombsquad 1.6.11 (20538, 2022-03-23) released
Documentation is now generated using pdoc https://pdoc.dev. Thanks Dliwk!! (I'll get it wired up to auto-update to a webpage soon).
-
My first open-source package on PyPI: `spectrumdevice`, a high-level, object-oriented library for controlling Spectrum Instruments digitisers. A bit of a niche one!
There's a comprehensive README.md with installation and Quickstart information on GitHub, and reference documentation (auto generated by pdoc) on GitHub Pages.
-
Mitmproxy 7.0
Our main docs are built with Hugo (https://github.com/mitmproxy/mitmproxy/tree/main/docs). For our API docs we use pdoc (https://pdoc.dev), which integrates well with most static site generators. pdoc is also maintained by us. :)
-
Things I Wish I Knew as a New Python User
PEP 257 and a few others define "docstrings". Leverage them to make full use of autodoc tools. pdoc is a pretty fun tool that "just works". Build good habits from the start. Projects that have great documentation are just more attractive to me. If I come across a project that seems to do what I need, but has crappy documentation, I keep looking.
-
Show HN: Pdoc, a lightweight Python API documentation generator
Hi HN! Some of you may remember @BurntSushi's pdoc tool, a lightweight alternative to Sphinx. We're a bit in an unfortunate situation with a hostile work assuming our name [1], but I figured that we shouldn't give in and continue the legacy of that tool. Long story short, we have just published a major new "modern Python 3" release, which hopefully makes pdoc a really compelling option again. :-)
[1] https://github.com/mitmproxy/pdoc#pdoc-vs-pdoc3
What are some alternatives?
cheat-sheet-pdf - 📜 A Cheat-Sheet Collection from the WWW
sphinx - The Sphinx documentation generator
LeetCode-Solutions - 🏋️ Python / Modern C++ Solutions of All 3123 LeetCode Problems (Weekly Update)
MkDocs - Project documentation with Markdown.
Pycco - Literate-style documentation generator.
pdocs - A simple program and library to auto generate API documentation for Python modules.
pyment - Format and convert Python docstrings and generates patches
Programmers_guide_to_Python - Learn almost everything in python fast 🚀
pydoc-markdown - Create Python API documentation in Markdown format.