cloudpathlib
Python pathlib-style classes for cloud storage services such as Amazon S3, Azure Blob Storage, and Google Cloud Storage.
File Explorer
- docs-master.yml
- docs-preview.yml
- release.yml
- tests.yml
- codecov.yml
- failed_build_issue_template.md
- pull_request_template.md
- __init__.py
- azblobclient.py
- azblobpath.py
- __init__.py
- gsclient.py
- gspath.py
- __init__.py
- httpclient.py
- httppath.py
- glob.py
- __init__.py
- azure.py
- gs.py
- s3.py
- __init__.py
- localclient.py
- localpath.py
- __init__.py
- s3client.py
- s3path.py
- __init__.py
- anypath.py
- client.py
- cloudpath.py
- cloudpath_info.py
- enums.py
- exceptions.py
- patches.py
- py.typed
- url_utils.py
- anypath.md
- azblobclient.md
- azblobpath.md
- client.md
- cloudpath.md
- enums.md
- exceptions.md
- gsclient.md
- gspath.md
- local.md
- s3client.md
- s3path.md
- caching.py
- patching_builtins.py
- testing_mocked_cloudpathlib.py
- why_cloudpathlib.py
- custom_mkdocstrings.css
- extra.css
- .nbautoexport
- anypath-polymorphism.md
- authentication.md
- caching.ipynb
- favicon.svg
- http.md
- integrations.md
- logo-no-text.svg
- logo.svg
- other_client_settings.md
- patching_builtins.ipynb
- testing_mocked_cloudpathlib.ipynb
- why_cloudpathlib.ipynb
- make_support_table.py
- mkdocs.yml
- pytest.ini
- file0_0.txt
- file0_1.txt
- file0_2.txt
- file_1_0_0.txt
- file_1_0.txt
- __init__.py
- mock_adls_gen2.py
- mock_azureblob.py
- mock_gs.py
- mock_s3.py
- utils.py
- __init__.py
- cli.py
- perf_file_listing.py
- runner.py
- insecure-test.crt
- insecure-test.key
- insecure-test.pem
- __init__.py
- conftest.py
- http_fixtures.py
- test_anypath.py
- test_azure_specific.py
- test_caching.py
- test_client.py
- test_cloudpath_file_io.py
- test_cloudpath_instantiation.py
- test_cloudpath_internal.py
- test_cloudpath_manipulation.py
- test_cloudpath_serialize.py
- test_cloudpath_upload_copy.py
- test_gs_specific.py
- test_http.py
- test_integrations.py
- test_local.py
- test_patching.py
- test_s3_specific.py
- utils.py
- .env.example
- .gitignore
- AGENTS.md
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- HISTORY.md
- LICENSE
- Makefile
- pyproject.toml
- README.md
- requirements-dev.txt
- setup.cfg
# Use via CDN
jsDelivrjsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.
Command Glossary
Commands referenced in this DOCs, explained below.
conda install
View Details ▼
conda install
Install packages into an existing conda environment.
conda install {{package1 package2 ...}}
Install one or more package into the currently active conda environment:
conda install {{[-c|--channel]}} conda-forge {{package}}
Install a single package into the currently active conda environment using channel conda-forge:
conda install {{[-c|--channel]}} conda-forge --override-channels {{package}}
Install a single package into the currently active conda environment using channel conda-forge and ignoring other channels:
conda
View Details ▼
conda
Package, dependency, and environment management for any programming language.
Some subcommands such as `create` have their own usage documentation.
See also: `mamba`.
conda create {{[-n|--name]}} {{environment_name}} {{python=3.9 matplotlib}}
Create a new environment, installing named packages into it:
conda info {{[-e|--envs]}}
List all environments:
conda activate {{environment_name}}
Activate an environment:
glob
View Details ▼
glob
Glob patterns (`glob`) are patterns used to match and search text.
Note: `glob` isn't a command, but syntax to be used with other commands or the shell.
See also: `regex`.
*
Match zero or more of any characters:
?
Match any single character:
[{{abc}}]
Match one character in a set of characters:
pip install
View Details ▼
pip install
Install Python packages.
pip install {{package1 package2 ...}}
Install one or more packages:
pip install {{package1 package2 ...}} {{[-U|--upgrade]}}
Upgrade all specified packages to the latest version, installing any that are not already present:
pip install {{package}}=={{version}}
Install a specific version of a package:
readlink
View Details ▼
readlink
Follow symlinks and get symlink information.
readlink {{path/to/file}}
Get the actual file to which the symlink points:
readlink {{[-f|--canonicalize]}} {{path/to/file}}
Get the absolute path to a file:
rename
View Details ▼
rename
Rename a file or group of files with a `regex`.
WARNING: This command will overwrite files without prompting unless the dry-run option is used.
Note: This page refers to the Perl version, also known as `file-rename`.
rename 's/{{from}}/{{to}}/' {{*.txt}}
Replace `from` with `to` in the filenames of the specified files:
rename {{foo}} {{bar}} {{*}}
Rename files using simple substitutions (substitute `foo` with `bar` wherever found):
rename -n 's/{{from}}/{{to}}/' {{*.txt}}
Dry-run - display which changes would occur without performing them:
stat
View Details ▼
stat
Display file and filesystem information.
See also: `file`.
stat {{path/to/file}}
Display properties about a specific file such as size, permissions, creation date, and access date among others:
stat {{path/to/file}}
Show file properties such as size, permissions, creation date, and access date among others:
stat {{[-t|--terse]}} {{path/to/file}}
Display properties about a specific file, only showing the raw result data without labels:
unlink
View Details ▼
unlink
Remove a link to a file from the filesystem.
The file contents is lost if the link is the last one to the file.
unlink {{path/to/file}}
Remove the specified file if it is the last link:
copy
View Details ▼
copy
Copy files.
COPY {{path/to/source_file}} {{path/to/destination_file}}
Copy a file:
container
View Details ▼
container
Create and run Linux containers as lightweight virtual machines on macOS.
container system start
Start the container services (required before running containers):
container run --rm {{[-it|--interactive --tty]}} {{image}} {{sh}}
Run a container from an image interactively and remove it after it exits:
container run {{[-d|--detach]}} --name {{container_name}} {{[-p|--publish]}} {{8080:80}} {{image}}
Run a container in the background with a name and a published port:
md5
View Details ▼
md5
Calculate MD5 cryptographic checksums.
md5 {{path/to/file}}
Calculate the MD5 checksum for a file:
md5 {{path/to/file1 path/to/file2 ...}}
Calculate MD5 checksums for multiple files:
md5 -q {{path/to/file}}
Output only the MD5 checksum (no filename):
replace
View Details ▼
replace
Replace files.
See also: `robocopy`, `move`, `del`.
replace {{path\to\file_or_directory}} {{path\to\destination_directory}}
Replace the destination file with the one from the source directory:
replace {{path\to\file_or_directory}} {{path\to\destination_directory}} /a
Add files to the destination directory instead of replacing existing files:
replace {{path\to\file_or_directory}} {{path\to\destination_directory}} /p
Interactively copy multiple files, with a prompt before replacing or adding a destination file:
