Bump version: 0.1.0

rserial · Aug 3, 2024 · 6690321 · 6690321
1 parent 92c67e7
commit 6690321
Show file tree

Hide file tree

Showing 8 changed files with 19 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [0.1.0] - 2024-07-06
+## [0.1.0] - 2024-08-03
 ### Added
 - First release on PyPI.
 

diff --git a/CITATION.cff b/CITATION.cff
@@ -2,7 +2,7 @@
 # Visit https://bit.ly/cffinit to generate yours today!
 
 cff-version: 1.2.0
-title: Flintpy
+title: Flintpy-NMR
 message: >-
   If you use this software, please cite it using the
   metadata from this file.
@@ -20,5 +20,7 @@ repository-code: 'https://github.com/rserial/flintpy'
 abstract: Python implementation of FLINT algorithm for NMR relaxation data.
 keywords:
   - flintpy
+  - flintpy-nmr
+  - nmr
 license: MIT
 version: 0.1.0
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,8 +1,8 @@
-# Contributing to Flintpy
+# Contributing to Flintpy-NMR
 
 👏🎉 First off all, Thanks for your interest in contributing to our project! 🎉👏
 
-The following is a set of guidelines for contributing to Flintpy. These are
+The following is a set of guidelines for contributing to Flintpy-NMR. These are
 mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
 
 ## Code of Conduct

diff --git a/README.md b/README.md
@@ -1,15 +1,15 @@
 
-# Flintpy
+# Flintpy-NMR
 
 
 <div align="center">
 
-[![PyPI - Version](https://img.shields.io/pypi/v/flintpy.svg)](https://pypi.python.org/pypi/flintpy)
-[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/flintpy.svg)](https://pypi.python.org/pypi/flintpy)
+[![PyPI - Version](https://img.shields.io/pypi/v/flintpy-nmr.svg)](https://pypi.python.org/pypi/flintpy-nmr)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/flintpy-nmr.svg)](https://pypi.python.org/pypi/flintpy-nmr)
 [![Tests](https://github.com/rserial/flintpy/workflows/tests/badge.svg)](https://github.com/rserial/flintpy/actions?workflow=tests)
 [![Codecov](https://codecov.io/gh/rserial/flintpy/branch/main/graph/badge.svg)](https://codecov.io/gh/rserial/flintpy)
 [![Read the Docs](https://readthedocs.org/projects/flintpy/badge/)](https://flintpy.readthedocs.io/)
-[![PyPI - License](https://img.shields.io/pypi/l/flintpy.svg)](https://pypi.python.org/pypi/flintpy)
+[![PyPI - License](https://img.shields.io/pypi/l/flintpy-nmr.svg)](https://pypi.python.org/pypi/flintpy-nmr)
 
 [![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
@@ -44,7 +44,7 @@ Check out the [notebooks](./notebooks) directory for Jupyter notebooks demonstra
 ## Installation
 
 ```
-pip install git+https://github.com/rserial/flintpy.git
+pip install flintpy-nmr
 ```
 ## Credits
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,4 +1,4 @@
-Welcome to Flintpy's documentation!
+Welcome to Flintpy-NMR's documentation!
 ===========================================================
 
 .. toctree::

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -8,13 +8,13 @@ Installation
 Stable release
 --------------
 
-To install flintpy, run this command in your terminal:
+To install Flintpy-NMR, run this command in your terminal:
 
 .. code-block:: console
 
-    $ pip install flintpy
+    $ pip install flintpy-nmr
 
-This is the preferred method to install flintpy, as it will always install the most recent stable release.
+This is the preferred method to install Flintpy-NMR, as it will always install the most recent stable release.
 
 If you don't have `pip`_ installed, this `Python installation guide`_ can guide
 you through the process.

diff --git a/docs/usage.rst b/docs/usage.rst
@@ -2,6 +2,6 @@
 Usage
 =====
 
-To use flintpy in a project::
+To use Flintpy-NMR in a project::
 
     import flintpy
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,13 +1,14 @@
 [tool.poetry]
-name = "flintpy"
+name = "flintpy-nmr"
+packages = [{include = "*", from="src"}]
 version = "0.1.0"
 description = "Python implementation of FLINT algorithm for NMR relaxation data."
 authors = ["Raquel Serial <raquelserial@gmail.com>"]
 readme = "README.md"
 homepage = "https://github.com/rserial/flintpy"
 repository = "https://github.com/rserial/flintpy"
 documentation = "https://flintpy.readthedocs.io"
-keywords = ["flintpy"]
+keywords = ["flintpy", "flintpy-nmr", "nmr"]
 classifiers=[
     "Development Status :: 2 - Pre-Alpha",
     "Intended Audience :: Developers",