ignisda / python-random-markdown-generator

Python library to generate random markdown text

Greetings 👋, I am Diptesh

I love to solve problems with code. I am based in New Delhi, India. You can find out more about me on my website.

Socials

• Github: IgnisDa
• Email: [email protected]
• Discord: @IgnisDa
• LinkedIn: https://www.linkedin.com/in/diptesh-choudhuri-0647501b9
• Website: https://diptesh.me

My presence in the FOSS community

Donations

If you like my projects and want to support their development, consider sponsoring me. Every single donation will be appreciated and will boost my motivation to keep on coding in open source 🙃.

• Buy me a coffee

Please don't forget to leave me some kind of message (with the donation or as a separate e-mail) to let me know which specific project the donations is for, what you like about it and what I can do to improve it further 🙂.

python-random-markdown-generator's Issues

Add new method to MarkdownGenerator called `new_code_block`

This method should be added to mdgen.markdown.MarkdownGenerator.
Here's what the method signature will look like:

def new_code_block(self, code, language='python'):
    pass

So that when the method is called, it will act something like:

>>> m = MarkdownGenerator()
>>> m.new_code_block("import os\nprint(os.cwd())", code="python")
```python
import os
print(os.cwd())
\``` 
>>> print('ok')
ok

(\ added because of escaping issues)

Note: The logic shouldn't be added to MarkdownGenerator directly. Instead a releavant class should be created in mdgen/core/code.py (create if necessary) and then imported from there. See source code to understand what I mean.

Also please make your PR to the dev branch.

Add new method to MarkdownGenerator called `new_blockquote`

This method should be added to mdgen.markdown.MarkdownGenerator.
Here's what the method signature will look like:

def new_blockquote(self, quote: str):
    pass

So that when the method is called, it will act something like:

>>> m = MarkdownGenerator()
>>> m.new_blockquote("Some epic quote by gandhi")
> Some epic quote by gandhi

Note: The logic shouldn't be added to MarkdownGenerator directly. Instead a relevant class should be created in mdgen/core/blockquote.py (create if necessary) and then imported from there. See source code to understand what I mean.

Also please make your PR to the dev branch.

Add checks to Travis configuration file

At the time of writing, the CI tests are run using Travis CI. In .travis.yml and under the script section, you'll notice that coverage run --source mdgen -m pytest is invoked. This is done to ensure that code coverage is picked up by coveralls.io inspite of the testing already being automated using tox. This results in pytest running trice, once for each python interpretor on travis. This is redundant and a waste of machine power and can be fixed quite easily.

What to do: Simple add a conditional in .travis.yml checking if $TRAVIS_PYTHON_VERSION is 3.8.5 and if it is- only then run coverage run --source mdgen -m pytest. Relevant line: https://github.com/IgnisDa/python-random-markdown-generator/blob/dev/.travis.yml#L18

Write examples for flask

I have included a short example of how to use this package with django in docs/example,rst. However I don't know flask but I am sure this package can be used for flask too.

What you need to do: Edit docs/examples.rst and add an example using flask under the Implementation in flask section. You should follow a similar structure as the django example does. The code involving mdgen should be same as the ones in django. Please make sure you add relevant links whenever you use them. The documentation should be short, concise and self explanatory.

Important note: Please make your PR to dev branch. The master branch doesn't accept PRs.