Rename (#8)

* add publish workflow on tag push * rename package
OlivierBinette · Nov 25, 2023 · 6e19251 · 6e19251
1 parent 006fd02
commit 6e19251
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ The package has no external dependencies beyond Python's standard library and is
 ## Installation
 
 ```bash 
-pip install bettercsv
+pip install csvmeta
 ```
 
 ## Usage
@@ -29,7 +29,7 @@ pip install bettercsv
 Input and ouput data formats for the `read` and `write` functions are modelled on Python's csv module: data to write should be an iterable of rows, and data read will be an iterable of rows with string data types. The data header is always returned as the first row.
 
 ```python
-import bettercsv as bcsv
+import csvmeta as csvm
 
 data = [
     ['name', 'age', 'state'],
@@ -38,10 +38,10 @@ data = [
 ]
 
 # Write data to a csv file folder
-bcsv.write('mydata.csv', data)
+csvm.write('mydata.csv', data)
 
 # Read data from a csv file folder
-data = bcsv.read('mydata.csv')
+data = csvm.read('mydata.csv')
 list(data)
 ## [
 ##     ['name', 'age', 'state'],
@@ -60,7 +60,7 @@ Arbitrary metadata can be added to the metadata file by passing keyword argument
 Metadata can be read using the `metadata()` function
 
 ```python
-import bettercsv as bcsv
+import csvmeta as csvm
 
 data = [
     ['name', 'age', 'state'],
@@ -69,7 +69,7 @@ data = [
 ]
 
 # Write data and metadata to a csv file folder
-bcsv.write(
+csvm.write(
     'mydata.csv', 
     data, 
     header=True, 
@@ -83,7 +83,7 @@ bcsv.write(
     )
 
 # Read metadata from a csv file folder
-bcsv.metadata('mydata.csv')
+csvm.metadata('mydata.csv')
 ## {
 ##     "name": "mydata.csv",
 ##     "path": "data.csv",

diff --git a/bettercsv/__init__.py → csvmeta/__init__.py b/bettercsv/__init__.py → csvmeta/__init__.py
diff --git a/bettercsv/read.py → csvmeta/read.py b/bettercsv/read.py → csvmeta/read.py
diff --git a/bettercsv/write.py → csvmeta/write.py b/bettercsv/write.py → csvmeta/write.py
diff --git a/pyproject.toml b/pyproject.toml
@@ -3,7 +3,7 @@ requires = ["setuptools", "setuptools-scm"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "bettercsv"
+name = "csvmeta"
 version = "1.0.0"
 description = "Lightweight csv read/write, keeping track of csv dialect and other metadata."
 authors = [{ name = "Olivier Binette", email = "[email protected]" }]
@@ -29,7 +29,7 @@ homepage = "https://github.com/OlivierBinette/BetterCSV"
 Issues = "https://github.com/OlivierBinette/BetterCSV/issues"
 
 [tool.setuptools.packages.find]
-include = ["bettercsv", "bettercsv.*"]
+include = ["csvmeta", "csvmeta.*"]
 namespaces = false
 
 [tool.black]