Add arcade new Improvements
#156
Conversation
There was a problem hiding this comment.
Overall really great. This allows anyone to really quickly make a great toolkit. I made an obsidian toolkit really quickly with this. https://github.com/Spartee/arcade-obsidian
couple bumps we need to think about but overall great stuff.
arcade/arcade/templates/{{ toolkit_name }}/tests/test_{{ toolkit_name }}.py
Show resolved
Hide resolved
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
| "toolkit_description": toolkit_description, | ||
| "toolkit_author_name": toolkit_author_name, | ||
| "toolkit_author_email": toolkit_author_email, | ||
| "arcade_version": f"{ARCADE_VERSION.rsplit('.', 1)[0]}.*", |
There was a problem hiding this comment.
nit, but we are not validating this anywhere and just trusting that it has a .
| ## Creating your new toolkit repo | ||
|
|
||
| 1. Run `arcade new` and answer all the questions | ||
| 2. Navigate to your new toolkit directory: | ||
| ```bash | ||
| cd {{ toolkit_name }} | ||
| ``` | ||
| 3. Initialize git repository: | ||
| ```bash | ||
| git init | ||
| ``` | ||
| 4. Create a new repository in Github with the same name as your new toolkit | ||
| > Note: Don't create a README, LICENSE or .gitignore when creating the repository because `arcade new` has already created these files for you. | ||
| 5. Add remote and push your code: | ||
| ```bash | ||
| git remote add origin https://github.com/{{ toolkit_author_name }}/{{ toolkit_name }}.git | ||
| git branch -M main | ||
| git add . | ||
| git commit -m "Initial commit" | ||
| git push -u origin main | ||
| ``` | ||
|
|
||
| ## Publishing to PyPi | ||
|
|
||
| ### Generating a PyPi API Key | ||
|
|
||
| 1. Log into your PyPi account | ||
| 2. Navigate to your Account settings and add an API token | ||
| 3. Copy the token | ||
| 4. In your Github repository: | ||
| - Go to Settings > Secrets and variables > Actions | ||
| - Click "New repository secret" | ||
| - Name your secret `PYPI_TOKEN` | ||
| - Paste your API Token into the Secret field | ||
|
|
||
| ### Creating a Release | ||
|
|
||
| 1. Navigate to your Github repository and click on Releases | ||
| 2. Create a new tag that corresponds to the version in your toolkit's `pyproject.toml` file | ||
| > Note: This will be 0.0.1 for your first release |
There was a problem hiding this comment.
It almost feels like these instructions belong somewhere else. This part is not really a README for the toolkit, but rather for the one-time process of creating a toolkit.
|
Confirmed that all of @Spartee's review notes were either addressed in this PR, or will be filed as follow-ups by @EricGustin |
PR Description
This PR is a part of the community contributed toolkits story.
arcade newnow uses jinja templatesarcade newnow creates a "cookiecutter" toolkit equipped with everything a community contributed toolkit needs to be easily tested, published to PyPi, etc. as its own Github repoarcade new: