Skip to content
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

Add barebones docs for ConanAPI #17638

Merged
merged 1 commit into from
Jan 27, 2025
+8 −0
Merged

Add barebones docs for ConanAPI #17638

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: 8 additions & 0 deletions conan/api/conan_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,11 @@


class ConanAPI:
"""
This is the main object to interact with the Conan API. It provides all the subapis to work with
recipes, packages, remotes, etc., which are exposed as attributes of this class, and should
not be created directly.
"""
def __init__(self, cache_folder=None):

version = sys.version_info
Expand Down Expand Up @@ -61,6 +66,9 @@ def __init__(self, cache_folder=None):
_check_conan_version(self)

def reinit(self):
"""
Reinitialize the Conan API. This is useful when the configuration changes.
"""
self.config.reinit()
self.remotes.reinit()
self.local.reinit()
Expand Down
Loading