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.

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 plugin: pycalc #4686

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Conversation

pycalc-plugin
Copy link

@pycalc-plugin pycalc-plugin commented Nov 14, 2024

I am submitting a new Community Plugin

Repo URL

Link to my plugin: https://github.com/pycalc-plugin/obsidian

Release Checklist

  • I have tested the plugin on
    • Windows
    • macOS
    • Linux
    • Android (if applicable)
    • iOS (if applicable)
  • My GitHub release contains all required files (as individual files, not just in the source.zip / source.tar.gz)
    • main.js
    • manifest.json
    • styles.css (optional)
  • GitHub release name matches the exact version number specified in my manifest.json (Note: Use the exact version number, don't include a prefix v)
  • The id in my manifest.json matches the id in the community-plugins.json file.
  • My README.md describes the plugin's purpose and provides clear usage instructions.
  • I have read the developer policies at https://docs.obsidian.md/Developer+policies, and have assessed my plugins's adherence to these policies.
  • I have read the tips in https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines and have self-reviewed my plugin to avoid these common pitfalls.
  • I have added a license in the LICENSE file.
  • My project respects and is compatible with the original license of any code from other plugins that I'm using.
    I have given proper attribution to these other projects in my README.md.

@ObsidianReviewBot
Copy link
Collaborator

Thank you for your submission, an automated scan of your plugin code's revealed the following issues:

Required

[1]:Remember to rename the sample classes to something that makes sense to your plugin. If there are any errors, Obsidian will spit out this class name, so this will be important for users to debug if they need to.


Do NOT open a new PR for re-validation.
Once you have pushed all of the required changes to your repo, the bot will update the labels on this PR within 6 hours.
If you think some of the required changes are incorrect, please comment with /skip and the reason why you think the results are incorrect.

@ObsidianReviewBot ObsidianReviewBot self-assigned this Nov 15, 2024
@ObsidianReviewBot ObsidianReviewBot added Changes requested Additional review required PR needs to be reviewed by another person, after the currently requested changes have been made Ready for review and removed Ready for review Changes requested Additional review required PR needs to be reviewed by another person, after the currently requested changes have been made labels Nov 15, 2024
@ObsidianReviewBot ObsidianReviewBot removed their assignment Nov 15, 2024
@ObsidianReviewBot
Copy link
Collaborator

Changes requested by bot have been made, assigning human for additional review.

@pycalc-plugin
Copy link
Author

I updated the contents of the 1.0.0 release without changing the version, do I need any additional steps?

@joethei
Copy link
Collaborator

joethei commented Nov 18, 2024

Remove the styles.css file from your release, since it's empty it's just unnecessary bloat that Obsidian would download.

"description": "The pycalc plugin enables the execution of python code directly within the editor upon pressing the Enter key.",
Avoid including sentences like "This is a plugin that does ..." in your description, it should be a given since this is only shown when browsing plugins through the app or on our website.
We have published a guide for plugin descriptions to follow here: https://docs.obsidian.md/Plugins/Releasing/Submission+requirements+for+plugins#Keep+plugin+descriptions+short+and+simple.
Also, "Python" is a name and is capitalized

python
Same here.

The bryton.min.js and brython_stdlib.js files are hard to read, could you please include the non minfied version in the repo?
For the release you can enable minification in esbuild.

@joethei joethei added Changes requested Minor changes requested PR can be merged after some final changes have been requested and removed Ready for review labels Nov 18, 2024
@pycalc-plugin
Copy link
Author

pycalc-plugin commented Nov 18, 2024

bryton this is not my code, are you sure you need to include the non-minified version?

As for brython_stdlib.js, I did not find the non-minified version, it is minified python code in a js wrapper.

you can see the diff between my repo and the original from brython
https://brython.info/static_doc/3.12/en/install.html

other requests have been fulfilled

@joethei
Copy link
Collaborator

joethei commented Nov 21, 2024

Prefered would be if you load brython as a dependency via your package.json.

@pycalc-plugin
Copy link
Author

pycalc-plugin commented Nov 21, 2024

I can't use brython as a dependency because I made some changes to make brython REPL similar to python REPL and to be able to use brython in my plugin.

The line that duplicated the original REPL request was removed from the original brython:

if($.src.mode&&$.src.mode=="single"&&["<console>","<stdin>"].indexOf($.src.filename)>-1){_b_.print(">",$.src.source.trim())}

The line for outputting the result in repr format was also changed.
from:

`_b_.print(result)\n`

to:

`_b_.print(_b_.repr(result))\n`

Copy link

Hello!

I found the following issues in your plugin submission

Errors:

❌ Could not parse community-plugins.json, invalid JSON. Expected ',' or ']' after array element in JSON at position 523570


This check was done automatically. Do NOT open a new PR for re-validation. Instead, to trigger this check again, make a change to your PR and wait a few minutes, or close and re-open it.

Copy link

Hello!

I found the following issues in your plugin submission

Errors:

❌ The newly added entry is not at the end, or you are submitting on someone else's behalf. The last plugin in the list is: prashanthpulisetti/password-audit. If you are submitting from a GitHub org, you need to be a public member of the org.


This check was done automatically. Do NOT open a new PR for re-validation. Instead, to trigger this check again, make a change to your PR and wait a few minutes, or close and re-open it.

Copy link

Hello!

I found the following issues in your plugin submission

Errors:

❌ The newly added entry is not at the end, or you are submitting on someone else's behalf. The last plugin in the list is: prashanthpulisetti/password-audit. If you are submitting from a GitHub org, you need to be a public member of the org.


This check was done automatically. Do NOT open a new PR for re-validation. Instead, to trigger this check again, make a change to your PR and wait a few minutes, or close and re-open it.

Copy link

Hello!

I found the following issues in your plugin submission

Errors:

❌ The newly added entry is not at the end, or you are submitting on someone else's behalf. The last plugin in the list is: prashanthpulisetti/password-audit. If you are submitting from a GitHub org, you need to be a public member of the org.


This check was done automatically. Do NOT open a new PR for re-validation. Instead, to trigger this check again, make a change to your PR and wait a few minutes, or close and re-open it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants