feat: refactoring and resetup

Author: moneebullah25

.gitignore

@@ -1,6 +1,7 @@
+.pypirc
 .env
 __pycache__/
-python-starter/__pycache__/
+python_nbdev_starter/__pycache__/
 *.pyc
 .ipynb_checkpoints/
 .mypy_cache/

README.md

@@ -1,4 +1,4 @@
-# python-starter
+# python_nbdev_starter
 
 
 <!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
@@ -11,16 +11,16 @@ documentation.
 If you are new to using `nbdev` here are some useful pointers to get you
 started.
 
-### Install python_starter in Development mode
+### Install python_nbdev_starter in Development mode
 
 ``` sh
-# make sure python_starter package is installed in development mode
+# make sure python_nbdev_starter package is installed in development mode
 $ pip install -e .
 
 # make changes under nbs/ directory
 # ...
 
-# compile to have changes apply to python_starter
+# compile to have changes apply to python_nbdev_starter
 $ nbdev_prepare
 ```
 
@@ -29,32 +29,32 @@ $ nbdev_prepare
 ### Installation
 
 Install latest from the GitHub
-[repository](https://github.com/moneebullah25/python-starter):
+[repository](https://github.com/moneebullah25/python_nbdev_starter):
 
 ``` sh
-$ pip install git+https://github.com/moneebullah25/python-starter.git
+$ pip install git+https://github.com/moneebullah25/python_nbdev_starter.git
 ```
 
-or from [conda](https://anaconda.org/moneebullah25/python-starter)
+or from [conda](https://anaconda.org/moneebullah25/python_nbdev_starter)
 
 ``` sh
-$ conda install -c moneebullah25 python_starter
+$ conda install -c moneebullah25 python_nbdev_starter
 ```
 
-or from [pypi](https://pypi.org/project/python-starter/)
+or from [pypi](https://pypi.org/project/python_nbdev_starter/)
 
 ``` sh
-$ pip install python_starter
+$ pip install python_nbdev_starter
 ```
 
 ### Documentation
 
 Documentation can be found hosted on this GitHub
-[repository](https://github.com/moneebullah25/python-starter)’s
-[pages](https://moneebullah25.github.io/python-starter/). Additionally
-you can find package manager specific guidelines on
-[conda](https://anaconda.org/moneebullah25/python-starter) and
-[pypi](https://pypi.org/project/python-starter/) respectively.
+[repository](https://github.com/moneebullah25/python_nbdev_starter)’s
+[pages](https://moneebullah25.github.io/python_nbdev_starter/).
+Additionally you can find package manager specific guidelines on
+[conda](https://anaconda.org/moneebullah25/python_nbdev_starter) and
+[pypi](https://pypi.org/project/python_nbdev_starter/) respectively.
 
 ## How to use
 

nbs/index.ipynb

@@ -7,14 +7,14 @@
    "outputs": [],
    "source": [
     "#| hide\n",
-    "from python_starter.core import *"
+    "from python_nbdev_starter.core import *"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# python-starter\n",
+    "# python_nbdev_starter\n",
     "\n",
     "> A template project to get started with production ready python projects"
    ]
@@ -44,21 +44,21 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Install python_starter in Development mode"
+    "### Install python_nbdev_starter in Development mode"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
     "```sh\n",
-    "# make sure python_starter package is installed in development mode\n",
+    "# make sure python_nbdev_starter package is installed in development mode\n",
     "$ pip install -e .\n",
     "\n",
     "# make changes under nbs/ directory\n",
     "# ...\n",
     "\n",
-    "# compile to have changes apply to python_starter\n",
+    "# compile to have changes apply to python_nbdev_starter\n",
     "$ nbdev_prepare\n",
     "```"
    ]
@@ -84,27 +84,27 @@
     "Install latest from the GitHub [repository][repo]:\n",
     "\n",
     "```sh\n",
-    "$ pip install git+https://github.com/moneebullah25/python-starter.git\n",
+    "$ pip install git+https://github.com/moneebullah25/python_nbdev_starter.git\n",
     "```\n",
     "\n",
     "or from [conda][conda]\n",
     "\n",
     "```sh\n",
-    "$ conda install -c moneebullah25 python_starter\n",
+    "$ conda install -c moneebullah25 python_nbdev_starter\n",
     "```\n",
     "\n",
     "or from [pypi][pypi]\n",
     "\n",
     "\n",
     "```sh\n",
-    "$ pip install python_starter\n",
+    "$ pip install python_nbdev_starter\n",
     "```\n",
     "\n",
     "\n",
-    "[repo]: https://github.com/moneebullah25/python-starter\n",
-    "[docs]: https://moneebullah25.github.io/python-starter/\n",
-    "[pypi]: https://pypi.org/project/python-starter/\n",
-    "[conda]: https://anaconda.org/moneebullah25/python-starter"
+    "[repo]: https://github.com/moneebullah25/python_nbdev_starter\n",
+    "[docs]: https://moneebullah25.github.io/python_nbdev_starter/\n",
+    "[pypi]: https://pypi.org/project/python_nbdev_starter/\n",
+    "[conda]: https://anaconda.org/moneebullah25/python_nbdev_starter"
    ]
   },
   {
@@ -120,10 +120,10 @@
    "source": [
     "Documentation can be found hosted on this GitHub [repository][repo]'s [pages][docs]. Additionally you can find package manager specific guidelines on [conda][conda] and [pypi][pypi] respectively.\n",
     "\n",
-    "[repo]: https://github.com/moneebullah25/python-starter\n",
-    "[docs]: https://moneebullah25.github.io/python-starter/\n",
-    "[pypi]: https://pypi.org/project/python-starter/\n",
-    "[conda]: https://anaconda.org/moneebullah25/python-starter"
+    "[repo]: https://github.com/moneebullah25/python_nbdev_starter\n",
+    "[docs]: https://moneebullah25.github.io/python_nbdev_starter/\n",
+    "[pypi]: https://pypi.org/project/python_nbdev_starter/\n",
+    "[conda]: https://anaconda.org/moneebullah25/python_nbdev_starter"
    ]
   },
   {

nbs/nbdev.yml

@@ -2,8 +2,8 @@ project:
   output-dir: _docs
 
 website:
-  title: "python-starter"
-  site-url: "https://moneebullah25.github.io/python-starter"
+  title: "python_nbdev_starter"
+  site-url: "https://moneebullah25.github.io/python_nbdev_starter"
   description: "A template project to get started with production ready python projects"
   repo-branch: main
-  repo-url: "https://github.com/moneebullah25/python-starter"
+  repo-url: "https://github.com/moneebullah25/python_nbdev_starter"