Merge pull request #3 from rickecon/stuff

Merging

Author: rickecon

CHANGELOG.md

@@ -5,8 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.0.1] - 2023-09-28 18:30:00
+
+### Added
+
+- Updated `README.md` and `setup.py`
+- Deleted `changelog.yaml`
+
 ## [0.0.0] - 2023-09-28 17:00:00
 
 ### Added
 
 - Created CompMethods repository at GitHub.com/OpenSourceEcon/CompMethods
+
+
+
+[0.0.1]: https://github.com/OpenSourceEcon/CompMethods/compare/0.0.0...0.0.1

README.md

@@ -3,14 +3,14 @@
 | | |
 | --- | --- |
 | Org | [![OSE Lab cataloged](https://img.shields.io/badge/OSE%20Lab-catalogued-critical)](https://github.com/OpenSourceEcon) [![OS License: AGPL-3.0](https://img.shields.io/badge/OS%20License-AGPL%203.0-yellow)](https://github.com/OpenSourceEcon/CompMethods/blob/main/LICENSE) |
-| Package | [![Python 3.10](https://img.shields.io/badge/python-3.10-blue.svg)](https://www.python.org/downloads/release/python-31013/) [![PyPI Latest Release](https://img.shields.io/pypi/v/compmethods.svg)](https://pypi.org/project/compmethods/) [![PyPI Downloads](https://img.shields.io/pypi/dm/compmethods.svg?label=PyPI%20downloads)](https://pypi.org/project/compmethods/) |
+| Package | [![Python 3.10](https://img.shields.io/badge/python-3.10-blue.svg)](https://www.python.org/downloads/release/python-31013/) [![Python 3.11](https://img.shields.io/badge/python-3.11-blue.svg)](https://www.python.org/downloads/release/python-3115/) [![PyPI Latest Release](https://img.shields.io/pypi/v/compmethods.svg)](https://pypi.org/project/compmethods/) [![PyPI Downloads](https://img.shields.io/pypi/dm/compmethods.svg?label=PyPI%20downloads)](https://pypi.org/project/compmethods/) |
 | Testing | ![example event parameter](https://github.com/OpenSourceEcon/CompMethods/actions/workflows/build_and_test.yml/badge.svg?branch=main) ![example event parameter](https://github.com/OpenSource/CompMethods/actions/workflows/deploy_docs.yml/badge.svg?branch=main) ![example event parameter](https://github.com/OpenSourceEcon/CompMethods/actions/workflows/check_format.yml/badge.svg?branch=main) [![Codecov](https://codecov.io/gh/OpenSourceEcon/CompMethods/branch/main/graph/badge.svg)](https://codecov.io/gh/OpenSourceEcon/compmethods) |
 
-This repository contains the source material, code, and data for the book, [*Computational Methods for Economists using Python*](https://opensourceecon.github.io/CompMethods/), by Richard W. Evans (2023). This book is freely available online as an executable Jupyter Book at [url to book](https://opensourceecon.github.io/CompMethods/).
+This repository contains the source material, code, and data for the book, [*Computational Methods for Economists using Python*](https://opensourceecon.github.io/CompMethods/), by Richard W. Evans (2023). This book is freely available online as an executable Jupyter Book at https://opensourceecon.github.io/CompMethods.
 
 The materials for the book are constantly being updated. The version number listed in the [Releases](https://github.com/OpenSourceEcon/CompMethods/releases) section of the repository tracks the updates, as well as the [`CHANGELOG.md`](CHANGELOG.md) file.
 
-As an open executable book project, this book is happy to receive, address, and incorporate collaborative additions, corrections, suggestions, and questions. Please see the [Contributor Guide]() in the book for how to best collaborate with the project.
+As an open executable book project, this book is happy to receive, address, and incorporate collaborative additions, corrections, suggestions, and questions. Please see the [Contributor Guide](https://opensourceecon.github.io/CompMethods/contrib/contributing.html) in the book for how to best collaborate with the project.
 
 [Richard W. Evans, Phd](https://sites.google.com/site/rickecon) ([@rickecon](https://github.com/rickecon)) is the author of the book and the core maintainer of this repository.
 
@@ -21,4 +21,4 @@ General citation to the book:
 * Evans, Richard W., *Computational Methods for Economists using Python*, Open access Jupyter Book, v#.#.#, 2023, https://opensourceecon.github.io/CompMethods/.
 
 Citation to a chapter in the book:
-* Evans, Richard W., "[insert chapter name]", in *Computational Methods for Economists using Python*, Open access Jupyter Book, v#.#.#, 2023, https://opensourceecon.github.io/CompMethods/[chapter path].
+* Evans, Richard W., "[insert chapter name]", in *Computational Methods for Economists using Python*, Open access Jupyter Book, v#.#.#, 2023, https://opensourceecon.github.io/CompMethods/ + [chapter path].

changelog.yaml

@@ -30,13 +30,7 @@ All pull requests must be reviewed by someone else than their original author, w
 
 This project follows the [semantic versioning protocol](http://semver.org/). Any change impacts the version number, and the version number conveys API compatibility information **only**.
 
-Every pull request submitted to the main branch of the repository should update the `CHANGELOG.md` and `changelog.yaml` files as well as update the version number of the project in `setup.py`. These version updates to the version number and to the changelog file descriptions have the following structure and format:
-```yaml
-- bump: {major, minor, patch}
-  changes:
-    {added, removed, changed, fixed}:
-      - <variable or program>
-```
+Every pull request submitted to the main branch of the repository should update the `CHANGELOG.md` file as well as update the version number of the project in `setup.py`.
 
 ### Patch bump (3rd digit update)
 

docs/book/contrib/contributing.md

@@ -36,7 +36,7 @@ Put here a description of the code and tests available in the repository.
 Please use the following citation form for this book.
 
 General citation to the book:
-* Evans, Richard W., *Computational Methods for Economists using Python*, Open access Jupyter Book, v#.#.#, 2023, [url to book].
+* Evans, Richard W., *Computational Methods for Economists using Python*, Open access Jupyter Book, v#.#.#, 2023, https://opensourceecon.github.io/CompMethods.
 
 Citation to a chapter in the book:
-* Evans, Richard W., "[insert chapter name]", in *Computational Methods for Economists using Python*, Open access Jupyter Book, v#.#.#, 2023, [url to chapter].
+* Evans, Richard W., "[insert chapter name]", in *Computational Methods for Economists using Python*, Open access Jupyter Book, v#.#.#, 2023, https://opensourceecon.github.io/CompMethods + [chapter path].

docs/book/index.md

@@ -1,14 +1,14 @@
-"""This file contains the fiscalsim-us package's metadata and dependencies."""
+"""This file contains the CompMethods package's metadata and dependencies."""
 
 from setuptools import find_packages, setup
 
 with open("README.md", "r") as readme_file:
     readme = readme_file.read()
 
 setup(
-    name="UN-OG-Training",
-    version="0.0.0",
-    author="Jason DeBacker and Richard W. Evans",
+    name="CompMethods",
+    version="0.0.1",
+    author="Richard W. Evans",
     author_email="rickecon@gmail.com",
     long_description=readme,
     long_description_content_type="text/markdown",
@@ -17,13 +17,13 @@
         "License :: OSI Approved :: GNU Affero General Public License v3",
         "Operating System :: POSIX",
         "Programming Language :: Python",
-        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
         "Topic :: Scientific/Engineering :: Information Analysis",
     ],
-    description="UN open source OG-Core overlapping generations macroeconomic model training",
-    keywords="tax benefit macroeconomic dynamic general equilibrium fiscal",
+    description="Computational Methods for Economists using Python",
+    keywords="code python git github data science python regression causal inference structural estimation machine learning neural networks deep learning statistics econometrics",
     license="http://www.fsf.org/licensing/licenses/agpl-3.0.html",
-    url="https://github.com/OpenRG/UN-OG-Training",
+    url="https://github.com/OpenSourceEcon/CompMethods",
     include_package_data=True,  # Will read MANIFEST.in
     install_requires=[
         "numpy",
@@ -44,11 +44,9 @@
         "setuptools",
         "pytest",
         "coverage",
-        "ogcore",
         "linecheck",
         "yaml-changelog",
     ],
-    # Windows CI requires Python 3.9.
     python_requires=">=3.10",
     tests_require=["pytest"],
     packages=find_packages(),