Metadata-Version: 2.4
Name: anot
Version: 0.0.1
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Rust
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Scientific/Engineering
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Typing :: Typed
Requires-Dist: maturin >=1.7.8
License-File: LICENSE
Summary: Extract @annotations from source code comments
Author-email: Rory Byrne <rory@rory.bio>
License: MIT
Requires-Python: >=3.9
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Homepage, https://github.com/flywhl/anot
Project-URL: Repository, https://github.com/flywhl/anot
Project-URL: Documentation, https://github.com/flywhl/anot#readme
Project-URL: Bug Tracker, https://github.com/flywhl/anot/issues

# anot
Extract annotations from source-code comments.

# Usage

```python
# file.py

class Something(Experiment):
    # @note: this experiment will be re-written later
    
    def run(self):
        ...

        x = 5  # @hypothesis: 5 is better than 4

        ...
```

```bash
$ anot file.py --treesitter --tags hypothesis,note,todo --yaml

annotations:
  - kind: note
    content: this experiment will be re-written later
    context:
      node_type: class_definition
      parent_type: module
      associated_name: Something
      line_range: [2, 7]
  - kind: hypothesis
    content: 5 is better than 4
    context:
      node_type: assignment
      parent_type: function_definition
      associated_name: run
      line_number: 5
      variable_name: x
```

