complete all naming changes for the new repo + package name

Author: sr-murthy

Makefile

@@ -1,11 +1,11 @@
 SHELL := /bin/bash
 
-REPO := https://github.com/sr-murthy/fs-register-api-client
+REPO := https://github.com/sr-murthy/financial-services-register-api
 
-PACKAGE_NAME := fs-register-api-client
+PACKAGE_NAME := financial-services-register-api
 BRANCH := $(shell git rev-parse --abbrev-ref HEAD)
 HEAD := $(shell git rev-parse --short=8 HEAD)
-PACKAGE_VERSION := $(shell grep __version__ src/fs_register_api_client/__version__.py | cut -d '=' -f 2 | xargs)
+PACKAGE_VERSION := $(shell grep __version__ src/financial_services_register_api/__version__.py | cut -d '=' -f 2 | xargs)
 
 PROJECT_ROOT := $(PWD)
 
@@ -41,7 +41,7 @@ version_extract:
 # Dependency management
 update_deps:
 	@echo "\n$(PACKAGE_NAME)[$(BRANCH)@$(HEAD)]: Update all development dependencies, including documentation and production dependencies\n"
-	pdm update -v --dev --no-editable --no-self --update-all && pdm export -v -f requirements --dev -o docs/requirements.txt
+	pdm self update && pdm update -v --dev --no-editable --no-self --update-all && pdm export -v -f requirements --dev -o docs/requirements.txt
 
 # Linting
 lint: clean
@@ -52,7 +52,7 @@ lint: clean
 doctests: clean
 	@echo "\n$(PACKAGE_NAME)[$(BRANCH)@$(HEAD)]: Running doctests in all core libraries\n"
 	cd "$(PROJECT_ROOT)" && \
-	python -m doctest -v src/fs_register_api_client/*.py
+	python -m doctest -v src/financial_services_register_api/*.py
 
 unittests: clean
 	@echo "\n$(PACKAGE_NAME)[$(BRANCH)@$(HEAD)]: Running package unit tests + measuring coverage\n"

SECURITY.md

@@ -2,11 +2,4 @@
 
 ## Dependencies & Security Updates
 
-Currently, the only external dependency is [`requests`](https://requests.readthedocs.io/en/latest/). Security / vulnerability alerts are addressed as they arise from [Dependabot alerts](https://github.com/sr-murthy/fsrapiclient/security/dependabot).
-
-The project is enabled with a number of features to ensure security, including [CodeQL analysis](https://docs.github.com/en/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql), 
-[Dependabot alerts](https://docs.github.com/en/code-security/dependabot/dependabot-alerts/about-dependabot-alerts) and [secrets scanning](https://docs.github.com/en/code-security/secret-scanning/about-secret-scanning).
-
-## Reporting a Vulnerability
-
-Any vulnerability that could potentially impact package installation, performance or results should be reported privately via email to the maintainer: [s.murthy@tutanota.com](s.murthy@tutanota.com).
+Security issues are addressed via [Dependabot alerts](https://github.com/sr-murthy/fsrapiclient/security/dependabot), and other project features including [CodeQL analysis](https://docs.github.com/en/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql) and [secrets scanning](https://docs.github.com/en/code-security/secret-scanning/about-secret-scanning).

docs/conf.py

@@ -28,9 +28,8 @@
 sys.path.insert(0, os.path.dirname(os.path.abspath('.')))
 sys.path.insert(0, os.path.join(os.path.dirname(os.path.abspath('.')), 'src'))
 
-import fs_register_api_client
-
-from fs_register_api_client.__version__ import __version__
+import financial_services_register_api
+from financial_services_register_api.__version__ import __version__
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
@@ -41,10 +40,10 @@
               Lightweight Python client for the UK Financial Services Register RESTful API.
               """
 github_url = 'https://github.com'
-github_repo = f'{github_url}/sr-murty/fs-register-api-client'
+github_repo = f'{github_url}/sr-murty/financial-services-register-api'
 github_version = 'main'
-pypi_project = 'https://pypi.org/project/fs-register-api-client/'
-project = fs_register_api_client.__name__
+pypi_project = 'https://pypi.org/project/financial-services-register-api/'
+project = financial_services_register_api.__name__
 release = __version__
 
 # -- General configuration ---------------------------------------------------
@@ -70,8 +69,8 @@
 .. |project|                replace:: **{project}**
 .. |project_description|    replace:: {description}
 .. |release|                replace:: **{release}**
-.. |github_release_target|  replace:: https://github.com/sr-murthy/fs-register-api-client/releases/tag/{release}
-.. |pypi_release_target|    replace:: https://pypi.org/project/fs-register-api-client/{release}
+.. |github_release_target|  replace:: https://github.com/sr-murthy/financial-services-register-api/releases/tag/{release}
+.. |pypi_release_target|    replace:: https://pypi.org/project/financial-services-register-api/{release}
 """
 
 # Publish author(s)
@@ -160,9 +159,9 @@
 pygments_style = 'sphinx'
 
 # A list of prefixes that are ignored when creating the module index. (new in Sphinx 0.6)
-modindex_common_prefix = ["fs_register_api_client."]
+modindex_common_prefix = ["financial_services_register_api."]
 
-doctest_global_setup = "import fs_register_api_client"
+doctest_global_setup = "import financial_services_register_api"
 
 # If this is True, the ``todo`` and ``todolist`` extension directives
 # produce output, else they produce nothing. The default is ``False``.
@@ -178,56 +177,25 @@
     'display_github': True,
     'github_url': 'https://github.com',
     'github_user': 'sr-murthy',
-    'github_repo': 'fs-register-api-client',
+    'github_repo': 'financial-services-register-api',
     'github_version': 'main',
     'doc_path': 'docs',
     'conf_path': 'docs/conf.py',
     'project': project,
     'project_description': description,
     'release': release,
-    'release_target': f'https://github.com/sr-murthy/fs-register-api-client/releases/tag/{release}'
+    'release_target': f'https://github.com/sr-murthy/financial-services-register-api/releases/tag/{release}'
 }
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 # General (non-theme) HTML output options
-html_baseurl = 'https://fs-register-api-client.readthedocs.io'
-
-#html_sidebars = {
-#    "sources/getting-started": [],
-#    "sources/creating-continued-fractions": [],
-#    "sources/exploring-continued-fractions": [],
-#    "sources/sequences": [],
-#    "sources/contributing": [],
-#    #"sources/fs-register-api-client/*": ["sidebar-nav-bs"],
-#}
+html_baseurl = 'https://financial-services-register-api.readthedocs.io'
 
 # HTML theme options
 html_theme = 'furo'
-html_theme_options = {
-    #'collapse_navigation': True,
-    #'footer_end': ['author'],
-    #'footer_start': ['copyright', 'sphinx-version', 'theme-version'],
-    #'icon_links': [
-    #    {
-    #        'name': 'fs-register-api-client@GitHub',
-    #        'url': f'https://github.com/sr-murthy/fs-register-api-client',
-    #        'icon': 'fa-brands fa-github',
-    #    },
-    #],
-    #'navbar_persistent': ['search-button'],
-    #'navbar_align': 'content',
-    #'navbar_center': ['navbar-nav'],
-    #'navbar_end': ['theme-switcher', 'navbar-icon-links'],
-    #'navbar_start': ['navbar-logo'],
-    #'navigation_depth': 4,
-    #"primary_sidebar_end": ["indices", "sidebar-ethical-ads"],
-    #'secondary_sidebar_items': ['page-toc', 'edit-this-page', 'sourcelink'],
-    #'show_nav_level': 2,
-    #'show_toc_level': 2,
-    #'use_edit_page_button': False,
-}
+html_theme_options = {}
 
 #html_logo = '_static/logo.png'
 
@@ -254,4 +222,4 @@
 html_copy_source = True
 
 # Output file base name for HTML help builder - use the project name
-htmlhelp_basename = 'fs-register-api-client'
+htmlhelp_basename = 'financial-services-register-api'

docs/index.rst

@@ -2,22 +2,22 @@
 
    :google-site-verification: 3F2Jbz15v4TUv5j0vDJAA-mSyHmYIJq0okBoro3-WMY
 
-============
-fs-register-api-client
-============
+===============================
+financial-services-register-api
+===============================
 
-A lightweight Python client library for the UK `Financial Services Register <https://register.fca.org.uk/s/>`_ `RESTful API <https://register.fca.org.uk/Developer/s/>`_.
+A Python client library for the UK `Financial Services Register <https://register.fca.org.uk/s/>`_ `RESTful API <https://register.fca.org.uk/Developer/s/>`_.
 
-The `PyPI package <https://pypi.org/project/fs-register-api-client>`_ is currently at version `0.5.1`.
+The `PyPI package <https://pypi.org/project/financial-services-register-api>`_ is currently at version `1.0.0`.
 
-The Financial Services Register, or FS Register, is a **public** database of all firms, individuals, funds, and other entities, that are either currently, or have been previously, authorised and/or regulated by the UK `Financial Conduct Authority (FCA) <https://www.fca.org.uk>`_ and/or the `Prudential Regulation Authority (PRA) <http://bankofengland.co.uk/pra>`_.
+The Financial Services Register (alternatively, FS Register), is a **public** database of all firms, individuals, funds, and other entities, that are either currently, or have been previously, authorised and/or regulated by the UK `Financial Conduct Authority (FCA) <https://www.fca.org.uk>`_ and/or the `Prudential Regulation Authority (PRA) <http://bankofengland.co.uk/pra>`_.
 
 .. note::
 
-   The FS Register API is free to use but accessing it, including via this library, requires
+   The  API is free to use but accessing it, including via this library, requires
    `registration <https://register.fca.org.uk/Developer/ShAPI_LoginPage?ec=302&startURL=%2FDeveloper%2Fs%2F#>`_. Registration involves a free sign up with an email, which is used as the API username in requests, and basic personal information. Once registered an API key is available from your registration profile.
 
-To learn more about the FS Register API structure please consult the `official documentation <https://register.fca.org.uk/Developer/s/>`_, or start :doc:`here <sources/fs-register-api>`.
+To learn more about the API please consult the `official documentation <https://register.fca.org.uk/Developer/s/>`_, or start :doc:`here <sources/financial-services-register-api>`.
 
 To get started with this package you can start :doc:`here <sources/getting-started>`.
 
@@ -27,7 +27,7 @@ If you're interested in contributing please consult the :doc:`contributing guide
    :maxdepth: 1
    :caption: Contents:
 
-   sources/fs-register-api
+   sources/financial-services-register-api
    sources/getting-started
    sources/usage
    sources/contributing