Skip to content

Commit

Permalink
Add installation instructions and regen docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
git-steven committed Feb 26, 2024
1 parent 4a02a92 commit 31e655c
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 5 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
# csv-batcher
A python-based, multiprocess CSV batcher suitable for
use with dataframes or other tools that deal with large CSV files (or those that require timely processing).

## Installation
pip install csv-batcher

## GitHub


## Documentation
https://tangledpath.github.io/csv-batcher/csv_batcher.html

Expand Down
9 changes: 7 additions & 2 deletions docs/csv_batcher.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ <h2>Contents</h2>
<li><a href="#csv-batcher">csv-batcher</a>
<ul>
<li><a href="#installation">Installation</a></li>
<li><a href="#github">GitHub</a></li>
<li><a href="#documentation">Documentation</a></li>
<li><a href="#usage">Usage</a></li>
<li><a href="#development">Development</a></li>
Expand Down Expand Up @@ -56,10 +57,14 @@ <h1 class="modulename">

<div class="docstring"><h1 id="csv-batcher">csv-batcher</h1>

<p>A python-based, multiprocess CSV batcher suitable for
use with dataframes or other tools that deal with large CSV files (or those that require timely processing).</p>

<h2 id="installation">Installation</h2>

<p>TBD (python package)
pip install csv-batcher</p>
<p>pip install csv-batcher</p>

<h2 id="github">GitHub</h2>

<h2 id="documentation">Documentation</h2>

Expand Down
2 changes: 1 addition & 1 deletion docs/search.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[tool.poetry]
name = "csv-batcher"
version = "0.1.2"
description = "A utility to split a large CSV into smaller ones, and uses multiprocessing to process the CSVs in parallel."
version = "0.1.3"
description = "A python utility to split a large CSV into smaller ones, and uses multiprocessing to process the CSVs in parallel."
authors = ["Steven Miers <[email protected]>"]
readme = "README.md"
license = "The Unlicense"
Expand Down

0 comments on commit 31e655c

Please sign in to comment.