{"id":19448593,"url":"https://github.com/neurodata/pedigo-project-template","last_synced_at":"2025-04-14T21:37:53.978Z","repository":{"id":140563251,"uuid":"486665703","full_name":"neurodata/pedigo-project-template","owner":"neurodata","description":"Cookiecutter project template","archived":false,"fork":false,"pushed_at":"2023-03-20T19:19:44.000Z","size":34156,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-14T21:37:48.695Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/neurodata.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-04-28T16:15:44.000Z","updated_at":"2024-11-06T09:53:24.000Z","dependencies_parsed_at":null,"dependency_job_id":"f1a556a7-1140-4ed5-a670-ec4f4a9508e4","html_url":"https://github.com/neurodata/pedigo-project-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neurodata%2Fpedigo-project-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neurodata%2Fpedigo-project-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neurodata%2Fpedigo-project-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neurodata%2Fpedigo-project-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/neurodata","download_url":"https://codeload.github.com/neurodata/pedigo-project-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248965683,"owners_count":21190656,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T16:27:46.960Z","updated_at":"2025-04-14T21:37:53.947Z","avatar_url":"https://github.com/neurodata.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pedigo's cookiecutter project template \n\n## Features\n- A local Python `pkg` for utility functions (e.g. saving figures, loading data, functions which are shared across notebooks/scripts)\n- [Poetry](https://python-poetry.org/) for environment specification.\n- [Jupyter Book](https://jupyterbook.org/en/stable/intro.html) hosted on [GitHub Pages](https://pages.github.com/) for documentation.\n- [Marp](https://marp.app/) for creating slides and posters.\n- [Overleaf](https://www.overleaf.com/) linking to facilitate writing a manuscript.\n- Shell scripts to facilitate: \n   - Conversion of Python scripts to Jupyter Notebooks, Jupyter Books, Marp slides.\n   - Running a collection of Python files to build an entire project.\n   - Copying generated figures and variables to an Overleaf repository.\n\n## Instructions\n### Using cookiecutter\n- Make sure you have [cookiecutter](https://cookiecutter.readthedocs.io/en/1.7.2/installation.html) installed.\n- From the command line, run \n  ```\n  cookiecutter https://github.com/neurodata/pedigo-project-template.git\n  ```\n- Answer each of the prompts from the command line.\n- Your new project should now be created!\n\n### Setting up GitHub\n- Create a [new repository on GitHub](https://github.com/organizations/neurodata/repositories/new).\n- Give your repo the same name that you did using the template.\n- Do not add any files to the repo when creating it on GitHub.\n- Follow the instructions on GitHub (roughly) to push to the newly created repo:\n  ```\n    git init\n    git add .\n    git commit -m \"initial\"\n    git branch -M main\n    git remote add origin https://github.com/neurodata/\u003crepo_name\u003e.git\n    git push -u origin main\n  ```\n  \n### Setting up GitHub Pages\n- On GitHub, click on the \"Settings\" tab.\n- Click on the `Pages` option.\n- Under `Source`, select `Branch: gh-pages`. This may only show up after a few minutes\n  when the first GitHub action has completed.\n  - You may also need to go to `Settings -\u003e Actrions -\u003e Workflow permissions` and set `Read and write permissions`.\n- Click `Save`.\n- Your documentation should now be available at `http://docs.neurodata.io/\u003crepo_name\u003e/`.\n- Navigate back to the repo page, and hit the settings gear icon to the right of `About`\n  on the upper right. Paste the URL for your documentation into the `Website` option so\n  that people can easily find your documentation. \n\n### Setting up Marp (VS Code instructions)\n- Get [Marp for VS Code](https://marketplace.visualstudio.com/items?itemName=marp-team.marp-vscode).\n- Access the Command Palette (on Mac it is ``Command + Shift + P`` by default) and type `Preferences: Open Workspace Settings (JSON)`.\n- Add the paths for the Marp themes to your `settings.json`. For me this looks like:\n  ```\n  \"markdown.marp.themes\": [\n     \"./\u003crepo_name\u003e/docs/slides/themes/poster.css\",\n     \"./\u003crepo_name\u003e/docs/slides/themes/slides.css\"\n  ],\n  ```\n\n### Setting up Overleaf\n*Coming soon*\n\n### Using the repository\nGuides to setting up an environment, running the code and using the shell scripts in\nyour repo, and building the documentation are provided within the repo created by\n`cookiecutter` so that users of your repository can see them, too.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneurodata%2Fpedigo-project-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fneurodata%2Fpedigo-project-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneurodata%2Fpedigo-project-template/lists"}