Skip to main content
# bitfieldpy
Python3 porting of [bitfield](https://github.com/drom/bitfield) with all respect
to the original designer.

`python3 bitfield.py bitfield.json > bitfield.svg`

The library works exactly same as original program, except some of command line options.

- Added `-s/--svg` to output to a file in addition with redirecting(`>`)
- More strict to JSON format

# Install
The library requires svgwrite and attrdict libraries.

- `pip3 install bitfieldpy`(install archive from pypi)
- `pip3 install git+https://github.com/K4zuki/bitfieldpy.git`(edge/developing version)

# Options

```
usage: bitfieldpy.py [-h] [--input INPUT] [--svg SVG] [--vspace VSPACE]
[--hspace HSPACE] [--lanes LANES] [--bits BITS]
[--font-family FONT_FAMILY] [--font-weight FONT_WEIGHT]
[--font-size FONT_SIZE]

bitfield clone in python(experimental)

optional arguments:
-h, --help show this help message and exit
--input INPUT, -i INPUT
<input bitfield source filename>
--svg SVG, -s SVG <output SVG image file name>
--vspace VSPACE, -V VSPACE
height per lane in px
--hspace HSPACE, -H HSPACE
width per lane in px
--lanes LANES, -L LANES
number of lane
--bits BITS, -B BITS total bitwidth
--font-family FONT_FAMILY, -F FONT_FAMILY
font family for all texts
--font-weight FONT_WEIGHT, -W FONT_WEIGHT
font weight
--font-size FONT_SIZE, -S FONT_SIZE
font size
```

| parameter | optional | purpose | default |
|---------------------------|----------|---------------------------|--------------|
| `--input`/`-i` | **N** | input file name | |
| `--svg`/`-s` | **N** | output file name | |
| `--vspace`/`-V` | Y | height per lane in px | 80 |
| `--hspace`/`-H` | Y | width per lane in px | 640 |
| `--lanes`/`-L` | Y | number of lanes | 2 |
| `--bits`/`-B` | Y | total bit width | 32 |
| `--font-family`/`-F` | Y | font family for all texts | "sans-serif" |
| `--font-font_weight`/`-W` | Y | font weight | "normal" |
| `--font-size`/`-S` | Y | font size | 14 |

![Example](tests/images/bits.svg)

# License
**MIT License (c) 2018 Kazuki Yamamoto**

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bitfieldpy-0.0.9.tar.gz (10.7 kB view details)

Uploaded Source

File details

Details for the file bitfieldpy-0.0.9.tar.gz.

File metadata

  • Download URL: bitfieldpy-0.0.9.tar.gz
  • Upload date:
  • Size: 10.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.6.5

File hashes

Hashes for bitfieldpy-0.0.9.tar.gz
Algorithm Hash digest
SHA256 fec6c9c07346d6f24b770add1cf1d34d074fb913df47d3c850d632b8b3c9cf9b
MD5 5f77a25594038ea5f57524b066380e78
BLAKE2b-256 8b8e535098c660f34df256c8d54dc45095274e39602b899a3c4eeb022a48ed81

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.0.9 This release

1 file

0.0.8

1 file

0.0.7

1 file

0.0.5

1 file

0.0.4

1 file

0.0.3

1 file

0.0.2

1 file

0.0.1

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page