Skip to content

Change references to documentcloud to muckrock #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
duckduckgrayduck merged 1 commit into from
May 18, 2026
Merged

Change references to documentcloud to muckrock #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions docs/communications.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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``
::
Expand Down Expand Up @@ -36,7 +36,7 @@ CommunicationClient

Communication
----------------
.. class:: documentcloud.communications.Communication
.. class:: muckrock.communications.Communication

A representation of a single FOIA communication.

Expand Down
8 changes: 4 additions & 4 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/files.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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``.
::
Expand Down Expand Up @@ -37,7 +37,7 @@ FileClient

File
----------------
.. class:: documentcloud.files.File
.. class:: muckrock.files.File

A representation of a single FOIA file.

Expand Down
2 changes: 1 addition & 1 deletion docs/gettingstarted.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://docs.python.org/3/library/logging.html#logging-levels>`_ depending on your needs. For this example, we will use the DEBUG level. ::

Expand Down
4 changes: 2 additions & 2 deletions docs/jurisdictions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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``.
::
Expand Down Expand Up @@ -39,7 +39,7 @@ JurisdictionClient

Jurisdiction
----------------
.. class:: documentcloud.jurisdictions.Jurisdiction
.. class:: muckrock.jurisdictions.Jurisdiction

A representation of a jurisdiction.

Expand Down
4 changes: 2 additions & 2 deletions docs/make.bat
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
)

Expand Down
4 changes: 2 additions & 2 deletions docs/organizations.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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``.
Expand All @@ -31,7 +31,7 @@ OrganizationClient

Organization
----------------
.. class:: documentcloud.organizations.Organization
.. class:: muckrock.organizations.Organization

A representation of a single organization.

Expand Down
4 changes: 2 additions & 2 deletions docs/projects.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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``.
::
Expand All @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions docs/requests.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -60,7 +60,7 @@ RequestClient

Request
----------------
.. class:: documentcloud.requests.Request
.. class:: muckrock.requests.Request

A representation of a single FOIA request.

Expand Down
4 changes: 2 additions & 2 deletions docs/users.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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``.
::
Expand Down Expand Up @@ -40,7 +40,7 @@ UserClient

User
----------------
.. class:: documentcloud.users.User
.. class:: muckrock.users.User

A representation of a single user.

Expand Down
Loading