Merge pull request #12 from pace-gatech/update_new_repo

Changed files to reflect the new repo name (python_github_tutorial)

Author: bcrawford39GT

README.md

@@ -1,4 +1,4 @@
-#  github_tutorial 
+#  python_github_tutorial 
 
 ## Overview
 
@@ -12,15 +12,15 @@ To be added in the future.
 
 ## Installation
 
-The  github_tutorial package dependencies can be installed via conda, and this package tagged in conda via pip install:
+The  python_github_tutorial package dependencies can be installed via conda, and this package tagged in conda via pip install:
 
 Create and install conda package:
 
-`cd path_to_first_github_tutorial_dirctory_with_environment_yml_file`
+`cd path_to_first_python_github_tutorial_dirctory_with_environment_yml_file`
 
 `conda env create -f environment.yml`
 
-`conda activate github_tutorial`
+`conda activate python_github_tutorial`
 
 `pip install -e .`
 
@@ -30,7 +30,7 @@ Note: If you update the conda package, you may have to redo the pip install.  Wi
 
 ## Run the example
 
-This is an example of the supplimentary functions in the utils directory (github_tutorial/utils) and the main function in the main_functions directory (github_tutorial/main_functions).
+This is an example of the supplimentary functions in the utils directory (python_github_tutorial/utils) and the main function in the main_functions directory (python_github_tutorial/main_functions).
 
 The example is located here 'examples_to_run/examples.py'. The instructions to run it are provided below:
 
@@ -47,28 +47,28 @@ When using Visual Studios Code (VScode), the '# %%' above each section makes it
 
 ## Run the test cases (unit tests) using pytest
 
-The github_tutorial software tests the installation using `pytest <https://docs.pytest.org/en/stable/>`_. 
+The python_github_tutorial software tests the installation using `pytest <https://docs.pytest.org/en/stable/>`_. 
 The unit tests via ``pytest`` ensure that the code is build properly, running correctly and producing 
 accurate results.  
 
-To perform these tests (unit tests) for the github_tutorial package, please run the following commands 
-from the ``github_tutorial/tests`` directory:
+To perform these tests (unit tests) for the python_github_tutorial package, please run the following commands 
+from the ``python_github_tutorial/tests`` directory:
 
 Run all the tests:
 
-`cd github_tutorial/tests`
+`cd python_github_tutorial/tests`
 
 `pytest -v`
 
 Run individual test on 'test_math.py':
 
-`cd github_tutorial/tests`
+`cd python_github_tutorial/tests`
 
 `pytest test_math.py`
 
 Run individual test on 'test_main_functions.py':
 
-`cd github_tutorial/tests`
+`cd python_github_tutorial/tests`
 
 `pytest test_main_functions.py`
 
@@ -78,9 +78,9 @@ Building these HTML files locally via sphinx, which will allow you to access the
 local internet browsing application or HTML viewer (chrome, safari, VScode, etc.). 
 The HTML files will be located in the ``docs/_build/html`` directory after they are built.  
 
-The github_tutorial utilizes `sphinx <https://www.sphinx-doc.org/en/master/index.html>`_ to construct the documentation. 
+The python_github_tutorial utilizes `sphinx <https://www.sphinx-doc.org/en/master/index.html>`_ to construct the documentation. 
 The user can build the documentation locally by executing the following command from the ``docs`` directory:
 
-`conda activate github_tutorial`
+`conda activate python_github_tutorial`
 
 `make html`

docs/conf.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# github_tutorial documentation build configuration file, created
+# python_github_tutorial documentation build configuration file, created
 # on Wed Aug 8 2023.
 #
 
@@ -59,9 +59,9 @@
 
   <div class="admonition note">
       <p>This page was generated from
-        <a class="reference external" href="https://github.com/bcrawford39GT/github_tutorial/blob/{{ env.config.release|e }}/{{ docname|e }}">{{ docname|e }}</a>.
+        <a class="reference external" href="https://github.com/pace-gatech/python_github_tutorial/blob/{{ env.config.release|e }}/{{ docname|e }}">{{ docname|e }}</a>.
         <br>Interactive online version:
-        <a href="https://mybinder.org/v2/gh/bcrawford39GT/github_tutorial/github_tutorial/master?filepath={{ docname|e }}"><img alt="Binder badge" src="https://mybinder.org/badge_logo.svg" style="vertical-align:text-bottom"></a>.
+        <a href="https://mybinder.org/v2/gh/pace-gatech/python_github_tutorial/main?filepath={{ docname|e }}"><img alt="Binder badge" src="https://mybinder.org/badge_logo.svg" style="vertical-align:text-bottom"></a>.
       </p>
     </div>
 
@@ -114,7 +114,7 @@
 master_doc = "index"
 
 # General information about the project.
-project = "github_tutorial"
+project = "python_github_tutorial"
 author = ""
 copyright = ""
 
@@ -260,7 +260,7 @@
 # html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = "github_tutorial_doc"
+htmlhelp_basename = "python_github_tutorial_doc"
 
 # -- Options for LaTeX output ---------------------------------------------
 
@@ -298,7 +298,7 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
-latex_documents = [(latex_master_doc, "github_tutorial.tex", project, author, "howto")]
+latex_documents = [(latex_master_doc, "python_github_tutorial.tex", project, author, "howto")]
 latex_show_urls = "footnote"
 latex_show_pagerefs = False
 

docs/environment_docs.yml

@@ -1,9 +1,10 @@
-name: github_tutorial_docs
+name: python_github_tutorial_docs
 channels:
   - conda-forge
   - defaults
 dependencies:
   - python
+  - numpy
   - pytest
   - pip
   - mock

docs/getting_started/installation/installation.rst

@@ -6,11 +6,11 @@ Install an editable version from the source (GitHub)
 ----------------------------------------------------
 ::
 
-    $ cd path_to_first_github_tutorial_dirctory_with_environment_yml_file
+    $ cd path_to_first_python_github_tutorial_dirctory_with_environment_yml_file
 
     $ conda env create -f environment.yml
 
-    $ conda activate github_tutorial
+    $ conda activate python_github_tutorial
 
     $ pip install -e .
 
@@ -22,24 +22,24 @@ Building these HTML files locally via sphinx, which will allow you to access the
 local internet browsing application or HTML viewer (chrome, safari, VScode, etc.). 
 The HTML files will be located in the ``docs/_build/html`` directory after they are built.  
 
-The github_tutorial utilizes `sphinx <https://www.sphinx-doc.org/en/master/index.html>`_ to construct the documentation. 
+The python_github_tutorial utilizes `sphinx <https://www.sphinx-doc.org/en/master/index.html>`_ to construct the documentation. 
 The user can build the documentation locally by executing the following command from the ``docs`` directory::
     
-    $ conda activate github_tutorial
+    $ conda activate python_github_tutorial
     
     $ make html
 
 
 Testing the software installation
 ----------------------------------
 
-The github_tutorial software tests the installation using `pytest <https://docs.pytest.org/en/stable/>`_. 
+The python_github_tutorial software tests the installation using `pytest <https://docs.pytest.org/en/stable/>`_. 
 The unit tests via ``pytest`` ensure that the code is build properly, running correctly and producing 
 accurate results.  
 
-To perform these tests (unit tests) for the github_tutorial package, please run the following commands 
-from the ``github_tutorial/tests`` directory::
+To perform these tests (unit tests) for the python_github_tutorial package, please run the following commands 
+from the ``python_github_tutorial/tests`` directory::
 
-    $ conda activate github_tutorial
+    $ conda activate python_github_tutorial
     
     $ pytest -v

docs/getting_started/quick_start/add_2_numbers_example.rst

@@ -8,11 +8,11 @@ In general, you will add a detailed description for the example.
 All the classes and functions should not be listed in the examples. 
 Only the functions that the users will typically use should be listed here. 
 
-Import and use the github_tutorial ``add_2_numbers`` function.
+Import and use the python_github_tutorial ``add_2_numbers`` function.
 
 .. code:: ipython3
 
-    from github_tutorial.utils.math  import add_2_numbers
+    from python_github_tutorial.utils.math  import add_2_numbers
 
     # Enter the two (2) input variables numbers.
     no_0 = 1

docs/getting_started/quick_start/math_function_class_example.rst

@@ -8,11 +8,11 @@ the example.
 All the classes and functions should not be listed in the examples. 
 Only the functions that the users will typically use should be listed here. 
 
-Import and use the github_tutorial ``MathFunctionClass`` class.  
+Import and use the python_github_tutorial ``MathFunctionClass`` class.  
 
 .. code:: ipython3
 
-    from github_tutorial.main_functions.main_functions  import MathFunctionClass 
+    from python_github_tutorial.main_functions.main_functions  import MathFunctionClass 
 
     # enter the two (2) values to use
     entered_value_0 = 100

docs/getting_started/quick_start/quick_start_toc.rst

@@ -2,7 +2,7 @@
 Quick Start
 -----------------------
 
-This Quick Start guide for the github_tutorials repository is provided to help users 
+This Quick Start guide for the python_github_tutorials repository is provided to help users 
 start using the sofware for the most common needs, without an extensive code and 
 documentation review.
 

docs/getting_started/quick_start/tutorials.rst

@@ -2,7 +2,7 @@ Tutorials
 =========
 
 
-There are not tutorials for this github_tutorial repository.  
+There are not tutorials for this python_github_tutorial repository.  
 
 When building your own tutorials section, add the tutorials below 
 or a link to the tutorials (i.e., YouTube, etc.).

docs/index.rst

@@ -1,10 +1,10 @@
-GitHub Tutorial
-===============
+Python GitHub Tutorial
+======================
 
 .. image:: https://img.shields.io/badge/license-MIT-blue.svg
     :target: http://opensource.org/licenses/MIT
 
-This ``github_tutorial`` repository is an example of how to design
+This ``python_github_tutorial`` repository is an example of how to design
 and structure a GitHub repository, 
 and an example of how to structure and document Python code
 
@@ -72,6 +72,6 @@ input variables, attributes, methods, and outputs/output variables.
     	:maxdepth: 2
 
 	reference/units
-	reference/citing_github_tutorial
+	reference/citing_python_github_tutorial