semvec/pypi-packages huggingface dataset:
bip32template 0.0.4
Reference implementation of BIP32 templates
Requires Python: >=3.6
Keywords: bitcoin bip32

[![Package version](https://img.shields.io/pypi/v/bip32template.svg)](https://pypi.python.org/pypi/bip32template)
[![Package license](https://img.shields.io/pypi/l/bip32template.svg)](https://pypi.python.org/pypi/bip32template)
[![Python versions](https://img.shields.io/pypi/pyversions/bip32template.svg)](https://pypi.python.org/pypi/bip32template)
[![Build Status](https://api.travis-ci.org/dgpv/bip32_template_python_implementation.svg?branch=master)](https://pypi.python.org/pypi/bip32template)

# Python implementation of BIP32 path template parser finite state machine

(compatible with [micropython](https://micropython.org/))

This repository contains an implementation of specification of the parser for BIP32 path templates
described in [bip-path-templates.mediawiki](https://github.com/dgpv/bip32_template_parse_tplaplus_spec/blob/master/bip-path-templates.mediawiki)
and specified by TLA+ specification at [https://github.com/dgpv/bip32_template_parse_tplaplus_spec](https://github.com/dgpv/bip32_template_parse_tplaplus_spec)

The implementation is in `bip32template/__init__.py`

The tests is in `tests/`

To run tests on micropython, use `micropython_unittest.py` (you will need micropython-os.path module to run the tests)

to run static type checking, use `run_mypy.sh`

Example usage:

```python
>>> from bip32template import BIP32Template
>>> tpl=BIP32Template.parse('m/0h/[1-9,23]/*')
>>> tpl
BIP32Template([[(2147483648, 2147483648)], [(1, 9), (23, 23)], [(0, 2147483647)]], is_partial=False, hardened_marker="h")
>>> tpl.sections
[[(2147483648, 2147483648)], [(1, 9), (23, 23)], [(0, 2147483647)]]
>>> str(tpl)
'm/0h/[1-9,23]/*'
>>> str(BIP32Template(tpl.sections, hardened_marker="'", is_partial=True))
"0'/[1-9,23]/*"
>>> tpl.to_path() is None
True
>>> tpl.match([0x80000000, 3, 33])
True
>>> tpl.match([0x80000000, 99, 33])
False
>>> BIP32Template.parse('m/0/1/[2-3]', is_format_onlypath=True)
...
bip32template.BIP32TemplateExceptionUnexpectedCharacter: unexpected character at position 7
>>> ptpl = BIP32Template.parse('m/0h/1/2', is_format_onlypath=True)
>>> ptpl
BIP32Template([[(2147483648, 2147483648)], [(1, 1)], [(2, 2)]], is_partial=False, hardened_marker="h")
>>> ptpl.to_path()
[2147483648, 1, 2]
>>> tpl.match(ptpl.to_path())
True
>>> str(BIP32Template.from_path(ptpl.to_path(), is_partial=True))
"0'/1/2"
>>> str(BIP32Template.from_path(ptpl.to_path(), is_partial=False, hardened_marker="h"))
'm/0h/1/2'
```

## Authors and contributors

This implementation was created by Dmitry Petukhov (https://github.com/dgpv/)

## License

Released under MIT license.
isnalyser 0.1.0
Create isnad graphs automatically.
Requires Python: >=3.5

[![PyPI 
version](https://img.shields.io/badge/pypi%20package-0.0.1-brightgreen)](https://img.shields.io/badge/pypi%20package-0.0.1-brightgreen)
[![Contributions 
welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/Maroussia/isnalyser/blob/master/README.md)
[![GitHub 
license](https://img.shields.io/badge/license-GNU-orange)](https://github.com/Maroussia/isnalyser/blob/master/LICENSE)

# Automated isnād tree visualisations

For scholars studying Ḥadīth texts, drawing an __isnād__ tree with more than 40 transmitters is a tidious work and finding the right medium to desplay it fully can even prove to be impossible. The `isnalyser` is a simple program for the automation of __isnād__ trees drawing and their customable display in handy formats.


  <img src="https://user-images.githubusercontent.com/12030245/95599970-13c1dc00-0a52-11eb-96e9-f9969fdd572f.png" width="350">



## The motivation behind the project

The `isnalyser` aims at facilitating the analysis of large quantity of __aḥādīth__ and more specifically their chains of transmiters or __asānid__ by allowing scholars to visualise these chains of transmitters quickly in a complete graph that includes geo-spatial and chronological information.

## Who is it for?

The `isnalyser` is open-source and publicly available. It is meant for scholars in Ḥadīth studies who are analysing a great number of __aḥādīth__ and need to visualise their chains of transmitters in a single graph. The program can also be used by any scholars in Islamic studies or else who want to visualise the transmission of a text or its recension history. All data that follows the pattern of numerous chains of transmitters/scribes/citations/etc. can serve as input for the present program. 

## How?

Isnalyser can be installed easily and is ready to use within seconds.

### Installation
```bash
pip install isnalyser
```
### Usage
- A nice function of isnalyser is *view_graph*. Let's import it!

```python
from isnalyser import view_graph
```
- Now, if you already **have some data** available that you want to display as an Isnad tree, you can use the function we just imported like so:

```python
view_graph(
	'/path/to/your/data/transmitters.csv', # path to transmitters file
	'/path/to/your/data/transmissions.csv', # path to transmissions file
	15) # step size of timeline
```

- If you **don't have any data yet**, or just want to get a feel for it, we provided some examples. By looking at them, you can also find out how the data needs to be structured for isnalyser to work.

```python
view_graph(
	'', # you can write anyting here, as we don't need it
	'', # same is true here
	15, # 15 is a good step size for the example
	use_example=True) # use example data
```

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
isnalyser-stefan 0.1.0
Create isnad graphs automatically.
Requires Python: >=3.5

[![PyPI 
version](https://img.shields.io/badge/pypi%20package-0.0.1-brightgreen)](https://img.shields.io/badge/pypi%20package-0.0.1-brightgreen)
[![Contributions 
welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/Maroussia/isnalyser/blob/master/README.md)
[![GitHub 
license](https://img.shields.io/badge/license-GNU-orange)](https://github.com/Maroussia/isnalyser/blob/master/LICENSE)

# Automated isnād tree visualisations

For scholars studying Ḥadīth texts, drawing an __isnād__ tree with more than 40 transmitters is a tidious work and finding the right medium to desplay it fully can even prove to be impossible. The `isnalyser` is a simple program for the automation of __isnād__ trees drawing and their customable display in handy formats.


  <img src="https://user-images.githubusercontent.com/12030245/95599970-13c1dc00-0a52-11eb-96e9-f9969fdd572f.png" width="350">



## The motivation behind the project

The `isnalyser` aims at facilitating the analysis of large quantity of __aḥādīth__ and more specifically their chains of transmiters or __asānid__ by allowing scholars to visualise these chains of transmitters quickly in a complete graph that includes geo-spatial and chronological information.

## Who is it for?

The `isnalyser` is open-source and publicly available. It is meant for scholars in Ḥadīth studies who are analysing a great number of __aḥādīth__ and need to visualise their chains of transmitters in a single graph. The program can also be used by any scholars in Islamic studies or else who want to visualise the transmission of a text or its recension history. All data that follows the pattern of numerous chains of transmitters/scribes/citations/etc. can serve as input for the present program. 

## How?

Isnalyser can be installed easily and is ready to use within seconds.

### Installation
```bash
pip install isnalyser
```
### Usage
- A nice function of isnalyser is *view_graph*. Let's import it!

```python
from isnalyser import view_graph
```
- Now, if you already **have some data** available that you want to display as an Isnad tree, you can use the function we just imported like so:

```python
view_graph(
	'/path/to/your/data/transmitters.csv', # path to transmitters file
	'/path/to/your/data/transmissions.csv', # path to transmissions file
	15) # step size of timeline
```

- If you **don't have any data yet**, or just want to get a feel for it, we provided some examples. By looking at them, you can also find out how the data needs to be structured for isnalyser to work.

```python
view_graph(
	'', # you can write anyting here, as we don't need it
	'', # same is true here
	15, # 15 is a good step size for the example
	use_example=True) # use example data
```

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.