From ac2332f3180ba77f71c696aadb5ec6fa01618f8b Mon Sep 17 00:00:00 2001 From: duckduckgrayduck <102841251+duckduckgrayduck@users.noreply.github.com> Date: Mon, 18 May 2026 11:58:14 -0500 Subject: [PATCH] Change references to documentcloud to muckrock --- docs/Makefile | 8 ++++---- docs/communications.rst | 4 ++-- docs/conf.py | 8 ++++---- docs/files.rst | 4 ++-- docs/gettingstarted.rst | 2 +- docs/jurisdictions.rst | 4 ++-- docs/make.bat | 4 ++-- docs/organizations.rst | 4 ++-- docs/projects.rst | 4 ++-- docs/requests.rst | 4 ++-- docs/users.rst | 4 ++-- 11 files changed, 25 insertions(+), 25 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index 25448a5..e40383f 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -85,17 +85,17 @@ qthelp: @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/python-documentcloud.qhcp" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/python-muckrock.qhcp" @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/python-documentcloud.qhc" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/python-muckrock.qhc" devhelp: $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/python-documentcloud" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/python-documentcloud" + @echo "# mkdir -p $$HOME/.local/share/devhelp/python-muckrock" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/python-muckrock" @echo "# devhelp" epub: diff --git a/docs/communications.rst b/docs/communications.rst index 574fae9..396fd8c 100644 --- a/docs/communications.rst +++ b/docs/communications.rst @@ -5,7 +5,7 @@ Methods for searching and retrieving FOIA communications. CommunicationClient ---------------- -.. class:: documentcloud.communications.CommunicationClient +.. class:: muckrock.communications.CommunicationClient The communication client allows access to search, list, and retrieve individual FOIA communications. Accessed generally as ``clients.communications`` :: @@ -36,7 +36,7 @@ CommunicationClient Communication ---------------- -.. class:: documentcloud.communications.Communication +.. class:: muckrock.communications.Communication A representation of a single FOIA communication. diff --git a/docs/conf.py b/docs/conf.py index 98194f9..94201aa 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- # -# python-documentcloud documentation build configuration file, created by +# python-muckrock documentation build configuration file, created by # sphinx-quickstart on Sat Mar 15 15:49:29 2014. # # This file is execfile()d with the current directory set to its @@ -48,16 +48,16 @@ # General information about the project. project = "muckrock" -copyright = "2025, MuckRock Foundation, Inc." +copyright = "2026, MuckRock Foundation, Inc." # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = "2.0" +version = "2.2" # The full version, including alpha/beta/rc tags. -release = "2.0.0" +release = "2.2.0" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/files.rst b/docs/files.rst index 74c1c0c..e384cdd 100644 --- a/docs/files.rst +++ b/docs/files.rst @@ -5,7 +5,7 @@ Methods for searching and retrieving files attached to FOIA communications. FileClient ---------------- -.. class:: documentcloud.files.FileClient +.. class:: muckrock.files.FileClient The file client allows access to search, list, and retrieve individual FOIA files. Accessed generally as ``client.files``. :: @@ -37,7 +37,7 @@ FileClient File ---------------- -.. class:: documentcloud.files.File +.. class:: muckrock.files.File A representation of a single FOIA file. diff --git a/docs/gettingstarted.rst b/docs/gettingstarted.rst index e712036..e7acb5c 100644 --- a/docs/gettingstarted.rst +++ b/docs/gettingstarted.rst @@ -20,7 +20,7 @@ Before you can interact with MuckRock, you first must import the library and ini You can also specify a custom uri if you have installed your own version of MuckRock :: - >>> client = MuckRock(USERNAME, PASSWORD, base_uri="https://your.documentcloud.domain/api/", auth_uri="https://your.account.server.domain/api/") + >>> client = MuckRock(USERNAME, PASSWORD, base_uri="https://your.muckrock.domain/api/", auth_uri="https://your.account.server.domain/api/") If you need to debug, you can pass a logging level as a parameter to the client when you instantiate. You will need to import logging first. There are several `logging levels `_ depending on your needs. For this example, we will use the DEBUG level. :: diff --git a/docs/jurisdictions.rst b/docs/jurisdictions.rst index b18869f..32b937b 100644 --- a/docs/jurisdictions.rst +++ b/docs/jurisdictions.rst @@ -5,7 +5,7 @@ Methods for searching and retrieving jurisdictions. JurisdictionClient ---------------- -.. class:: documentcloud.jurisdictions.JurisdictionClient +.. class:: muckrock.jurisdictions.JurisdictionClient The jurisdiction client allows access to search, list, and retrieve individual jurisdictions. Accessed generally as ``client.jurisdictions``. :: @@ -39,7 +39,7 @@ JurisdictionClient Jurisdiction ---------------- -.. class:: documentcloud.jurisdictions.Jurisdiction +.. class:: muckrock.jurisdictions.Jurisdiction A representation of a jurisdiction. diff --git a/docs/make.bat b/docs/make.bat index 7469514..bb37a3f 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -115,9 +115,9 @@ if "%1" == "qthelp" ( echo. echo.Build finished; now you can run "qcollectiongenerator" with the ^ .qhcp project file in %BUILDDIR%/qthelp, like this: - echo.^> qcollectiongenerator %BUILDDIR%\qthelp\python-documentcloud.qhcp + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\python-muckrock.qhcp echo.To view the help file: - echo.^> assistant -collectionFile %BUILDDIR%\qthelp\python-documentcloud.ghc + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\python-muckrock.ghc goto end ) diff --git a/docs/organizations.rst b/docs/organizations.rst index e706138..01dd0c4 100644 --- a/docs/organizations.rst +++ b/docs/organizations.rst @@ -5,7 +5,7 @@ Methods for searching and retrieving organizations. OrganizationClient ---------------- -.. class:: documentcloud.organizations.OrganizationClient +.. class:: muckrock.organizations.OrganizationClient The organization client allows access to search, list, and retrieve individual organizations. Accessed generally as ``client.organizations``. @@ -31,7 +31,7 @@ OrganizationClient Organization ---------------- -.. class:: documentcloud.organizations.Organization +.. class:: muckrock.organizations.Organization A representation of a single organization. diff --git a/docs/projects.rst b/docs/projects.rst index 1cff24a..fe4ac3a 100644 --- a/docs/projects.rst +++ b/docs/projects.rst @@ -5,7 +5,7 @@ Methods for searching and retrieving projects. ProjectClient ---------------- -.. class:: documentcloud.projects.ProjectClient +.. class:: muckrock.projects.ProjectClient The project client allows access to search, list, and retrieve projects. Accessed generally as ``client.projects``. :: @@ -30,7 +30,7 @@ The project client allows access to search, list, and retrieve projects. Access Project ---------------- -.. class:: documentcloud.projects.Project +.. class:: muckrock.projects.Project A representation of a single project. diff --git a/docs/requests.rst b/docs/requests.rst index 9f5dbd2..18e5d72 100644 --- a/docs/requests.rst +++ b/docs/requests.rst @@ -5,7 +5,7 @@ Methods for searching, retrieving, and creating FOIA requests. RequestClient ---------------- -.. class:: documentcloud.requests.RequestClient +.. class:: muckrock.requests.RequestClient The request client allows access to search, list, create, and retrieve FOIA requests. Accessed generally as ``client.agencies``. Refer to the getting started page to look at some examples of searching and filing requests. @@ -60,7 +60,7 @@ RequestClient Request ---------------- -.. class:: documentcloud.requests.Request +.. class:: muckrock.requests.Request A representation of a single FOIA request. diff --git a/docs/users.rst b/docs/users.rst index 392ea15..3804af5 100644 --- a/docs/users.rst +++ b/docs/users.rst @@ -5,7 +5,7 @@ Methods for searching and retrieving users. UserClient ---------------- -.. class:: documentcloud.users.UserClient +.. class:: muckrock.users.UserClient The user client allows access to search, list, and retrieve individual users. Accessed generally as ``client.users``. :: @@ -40,7 +40,7 @@ UserClient User ---------------- -.. class:: documentcloud.users.User +.. class:: muckrock.users.User A representation of a single user.