{"id":13743207,"url":"https://github.com/asmeurer/brown-water-python","last_synced_at":"2025-09-01T20:11:16.533Z","repository":{"id":54179341,"uuid":"135779678","full_name":"asmeurer/brown-water-python","owner":"asmeurer","description":"More detailed documentation for the Python tokenize module","archived":false,"fork":false,"pushed_at":"2023-07-19T16:35:05.000Z","size":13866,"stargazers_count":9,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-08T19:03:27.476Z","etag":null,"topics":["documentation","python","python3","tokenize"],"latest_commit_sha":null,"homepage":"https://www.asmeurer.com/brown-water-python/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/asmeurer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-06-02T02:11:47.000Z","updated_at":"2022-10-25T20:17:13.000Z","dependencies_parsed_at":"2024-08-03T05:01:58.102Z","dependency_job_id":"d4830a02-1b4d-4d08-bded-e335bbfd2510","html_url":"https://github.com/asmeurer/brown-water-python","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/asmeurer/brown-water-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asmeurer%2Fbrown-water-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asmeurer%2Fbrown-water-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asmeurer%2Fbrown-water-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asmeurer%2Fbrown-water-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/asmeurer","download_url":"https://codeload.github.com/asmeurer/brown-water-python/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asmeurer%2Fbrown-water-python/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273183228,"owners_count":25059812,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-01T02:00:09.058Z","response_time":120,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","python","python3","tokenize"],"created_at":"2024-08-03T05:00:42.464Z","updated_at":"2025-09-01T20:11:16.510Z","avatar_url":"https://github.com/asmeurer.png","language":null,"funding_links":[],"categories":["Online resources"],"sub_categories":[],"readme":"\u003ca href=\"https://www.asmeurer.com/brown-water-python/\"\u003e\u003cimg src=\"docs/_static/water-python.jpg\" alt=\"logo\" width=\"50%\"\u003e\u003c/a\u003e\n\nBrown Water Python: Better Docs for the Python `tokenize` Module.\n=================================================================\n\nThis is my attempt to write some more helpful documentation for the Python\nstandard library [`tokenize`](https://docs.python.org/3/library/tokenize.html)\nmodule, in the style of [Green Tree\nSnakes](https://greentreesnakes.readthedocs.io/).\n\nBrown Water Python can be found at\nhttps://www.asmeurer.com/brown-water-python/\n\n## Building the HTML pages\n\nTo build the HTML pages, first install `sphinx` and `recommonmark`.\n\n    pip install sphinx recommonmark\n\nAt the moment, you also need the git versions of Sphinx and alabaster (this\nwill not be required once they do releases).\n\n    pip install -U git+https://github.com/asmeurer/alabaster/@rellinks-classes\n\nThen run\n\n    cd doc\n    make html\n\nThe resulting pages are in `_build/html`.\n\n## Doctests\n\nThe examples in are all doctested. You can run the doctests with\n\n    cd doc\n    ./run_doctests\n\nI have extended to doctests to add flags to skip doctests in Python 3.5, 3.6,\n3.7, and 3.8, to help test differences in the three language versions. The\nflags are `SKIP35`, `SKIP36`, `SKIP37`, and `SKIP38`, respectively. For\nexample, to make a doctest that doesn't run in Python 3.5, use\n\n```py\n\u003e\u003e\u003e # This is only valid syntax in Python 3.6+\n\u003e\u003e\u003e 123_456  # doctest: +SKIP35\n123456\n\n```\n\nTo make a doctest that only runs in Python 3.5, use something like\n\n\n```py\n\u003e\u003e\u003e # This is the behavior in Python 3.5\n\u003e\u003e\u003e 123_456 # doctest: +SKIP36, +SKIP37\nTraceback (most recent call last):\n  ...\n    123_456\n          ^\nSyntaxError: invalid syntax\n\n```\n\nThe `# doctest` comments are automatically hidden in the rendered output, so\nit's generally a good idea to include an explanatory comment that the given\ncode only runs on certain Python versions, as in the above examples.\n\nFor code that tests exceptions, you'll need to include `...` in the traceback\nto make it match.\n\nFor code that prints something and then has an exception, you'll have to skip\nit entirely (`# doctest: +SKIP`), as the doctest module does not support this.\n\n## Contributing\n\nContributions are welcome. So are questions. My goal here is to help people to\nunderstand the `tokenize` module, so if something is not clear, [please let me\nknow](https://github.com/asmeurer/brown-water-python/issues). If you see\nsomething written here that is wrong, please make a pull request correcting\nit. I'm not an expert at `tokenize`. I mainly know what is written here from\ntrial and error and from reading the source code.\n\nThe site is built with Sphinx using\n[recommonmark](https://recommonmark.readthedocs.io/), meaning the files are\nwritten in Markdown. If you need to add an reST structure that isn't supported\nby Markdown, you can either use raw HTML to emulate it, or use the\n[eval_rst](https://recommonmark.readthedocs.io/en/latest/auto_structify.html#embed-restructuredtext)\nconstruct to embed reST in the Markdown.\n\n## License\n\nEverything in this repo is licensed under the MIT license. See the LICENSE\nfile.\n\nThe Water Python image is by Matt from Melbourne, Australia [CC BY\n2.0](https://creativecommons.org/licenses/by/2.0), via [Wikimedia\nCommons](https://commons.wikimedia.org/wiki/File:Water_Python_(Liasis_mackloti)_(8692394648).jpg).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasmeurer%2Fbrown-water-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fasmeurer%2Fbrown-water-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasmeurer%2Fbrown-water-python/lists"}