chore: updates gitignore and set_default_profile.py (#60)

* chore: adds default Python .gitignore with trestle specific ignores

Signed-off-by: Jennifer Power <[email protected]>

* refactor: adds flag descriptions and formats set_default_profile.py

Signed-off-by: Jennifer Power <[email protected]>

---------

Signed-off-by: Jennifer Power <[email protected]>

.gitignore

@@ -1,4 +1,167 @@
-# Local Env
-.idea
-.trestle/cache/
-venv
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+*reports/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Local VSCode
+.vscode/
+
+# Trestle specific
+.trestle/cache

scripts/set_default_profile.py

@@ -16,7 +16,7 @@
 #    under the License.
 
 """
-Read in a profile created by trestle and set up default profile fields
+Read in a profile created by trestle and set up default profile fields.
 
 Author: Jenn Power <[email protected]>
 """
@@ -26,14 +26,20 @@
 from trestlebot.tasks.authored.profile import AuthoredProfile
 
 
-def main():
-    p = argparse.ArgumentParser(description="Set default component fields")
-    p.add_argument("--profile_name", required=True)
-    p.add_argument("--import_path", required=True)
-    p.add_argument("--trestle_root", required=True)
+def main() -> None:
+    p = argparse.ArgumentParser(description="Set default profile fields")
+    p.add_argument(
+        "--profile_name", help="Name of the profile to create", required=True
+    )
+    p.add_argument(
+        "--import_path",
+        help="Path to the profile or catalog to import in trestle workspace",
+        required=True,
+    )
+    p.add_argument("--trestle_root", default=".", required=False)
     args = p.parse_args()
 
-    authored_profile = AuthoredProfile(args.trestle_root)
+    authored_profile: AuthoredProfile = AuthoredProfile(args.trestle_root)
 
     authored_profile.create_new_default(
         args.import_path,
@@ -43,4 +49,3 @@ def main():
 
 if __name__ == "__main__":
     main()
-