semvec/pypi-packages huggingface dataset:
django-Environment-vars 0.103
A Django app to conduct Web-based polls.
License: MIT
Requires Python: >=3.6

=====
TODO
=====

Polls is a Django app to conduct Web-based polls. For each question,
visitors can choose between a fixed number of answers.

Detailed documentation is in the "docs" directory.

Quick start
-----------

1. Add "polls" to your INSTALLED_APPS setting like this::

    INSTALLED_APPS = [
        ...
        'django_contrib.environment_vars ',
    ]

2. Include the polls URLconf in your project urls.py like this::

    path('env/', include('django_contrib.environment_vars.urls'))

3. Run ``python manage.py migrate`` to create the polls models.

4. Start the development server and visit http://127.0.0.1:8000/env/
   to create a poll (you'll TODO).

5. Visit http://127.0.0.1:8000/env/ to participate in the poll.
clang-api-doc 0.4.0
Automatically generate API documentation for C language dialects
License: MIT
Requires Python: >=3.6,<4.0
Keywords: api,automatic,documentation

clang-api-doc
=============================

Generate C API documentation using libclang Python bindings.

For an example see the [documentation](https://clang-api-doc.readthedocs.io).

[![PyPI version](https://badge.fury.io/py/clang-api-doc.svg)](https://badge.fury.io/py/clang-api-doc)
[![CI](https://github.com/GPMueller/clang-api-doc/actions/workflows/ci.yml/badge.svg)](https://github.com/GPMueller/clang-api-doc/actions/workflows/ci.yml)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/61ce78fd4cbc41c29ec8eace9bdedca5)](https://www.codacy.com/gh/GPMueller/clang-api-doc/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=GPMueller/clang-api-doc&amp;utm_campaign=Badge_Grade)


Why?
-----------------------------

Ideally, code should be self-documenting. To me that means little to no documentation should be needed in
the code itself, as it strongly tends to harm readability if the code already explains itself. The
remaining use-cases for documentation are typically
 - **API references**, in particular assumed usage contracts
 - usage examples
 - installation instructions
 - general introductions

This project focuses on generating API references, as the other use-cases tend to be written separate from
the code.

The markdown-files generated by `clang-api-doc` can be used in any way you wish to create your final
documentation, for example
- `mkdocs`
- `sphinx`
- transform to a different format using `pandoc`


Installation
-----------------------------

The `clang-api-doc` package is on PyPI, so you can use `pip`, `poetry`, or whatever you like to install it,
for example `pip install clang-api-doc`.

To install it locally and in editable mode, simply install poetry and run `poetry install` and to load the
virtual environment run `poetry shell`.


CLI usage
-----------------------------

Simply call `clang-api-doc` once per file you wish to document, e.g.

```bash
clang-api-doc -i 'include/mylib/first.h' -o 'docs/first.md'
clang-api-doc -i 'include/mylib/second.h' -o 'docs/second.md'
```

or once per folder, e.g.

```bash
clang-api-doc -i 'include/mylib/' -o 'docs/'
```


Python package usage
-----------------------------

```python
from clang_api_doc import clang_api_doc

for file_in, file_out in zip(input_files, output_files):
    clang_api_doc.transform_file(file_in, file_out)
```
todo-or-die 0.1.1
Never let your TODOs rot in your python code ever again
License: MIT

# todo-or-die [Python edition]
Don't let your TODOs rot in your python projects anymore !

Inspired by :
- https://github.com/davidpdrsn/todo-or-die (Rust)
- https://github.com/searls/todo_or_die (Ruby)

## Examples
Once installed in your project, you can use it in any part of your code:

```python
from todo_or_die import todo_or_die, TodoOrDie

# raise an OverdueException when we're after a certain date or datetime
todo_or_die("This should be fixed by now.", by = datetime.datetime(2021, 6, 25, 15, 34, 55))

# raise an OverdueException when a given condition is true
todo_or_die("This should fail when we reach 1000 users", when = DB.users.count() > 1000)

# it also accepts a callable as a first argument
def myfunc():
    return 42

result = todo_or_die(myfunc, "Fix this in 6 months", by=datetime.date(2021, 6, 31))
result == 42 # True

# or simply any value will be passed back
result = todo_or_die(42, "Fix this in 6 months", by=datetime.date(2021, 6, 31))
result == 42 # True

# Finally, you can use it as a function decorator
@TodoOrDie("This function should be removed in the next version", when= build > 2000)
def myfunc(some = "arg"):
    pass

```

## Keep your projects clean
To understand why you would ever call a function to write a comment, read on.

If you have some code you know you'll need to change later, don't just leave a
comment for later that you'll never read, ever again.

For all the following cases, forgetting a TODO is NOT GOOD:
- remove some code when the dependency support expires, 
- remove a feature flag, 
- update some code related to another project,
- update a dependency when another refactoring is done,
- ...

This can lead to nasty issues so make your TODOs speak up when they need to 
with this module ;)

You can now replace your simple comment with this function that will raise
and error when the time or the condition are met and remind you to do something
about it.

## Caution
This can cause some production apps to break ! This code is named `todo_or_die`,
not `todo_and_kittens` so be careful.

Pull-Requests are welcome to make this more production-ready !

Note this module has no warranty, see the LICENSE !