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

Documentation request: How to create a custom grammar #238

Open
etaiklein opened this issue Jan 23, 2020 · 0 comments
Open

Documentation request: How to create a custom grammar #238

etaiklein opened this issue Jan 23, 2020 · 0 comments

Comments

@etaiklein
Copy link

etaiklein commented Jan 23, 2020

I want to allow trailing underscores in email addresses for me.com. Ex: 'test_@me.com'

The docs mention that I can add a custom grammar a plugin, but I'm really not sure where to start.

Currently the section in the user guide reads:

Custom grammar can be added by adding a plugin for the specific ESP to the flanker/addresslib/plugins directory. Then update flanker/addresslib/init.py to include the MX pattern for the ESP you wish to add and add it to the CUSTOM_GRAMMAR_LIST.

I believe this is referring to python packaging plugins. I found these instructions also difficult to follow.

Guiding questions: After pip installing flanker, should I create a plugin.py like these? Where should I put my custom plugin file? How do I install my new plugin? Do I need to fork the repo?

My ask is for clear and comprehensive instructions/examples for adding a custom grammar with screenshots.

@etaiklein etaiklein changed the title Documentation request: Improved documentation for how to create a custom grammar Documentation request: How to create a custom grammar w/ examples Jan 23, 2020
@etaiklein etaiklein changed the title Documentation request: How to create a custom grammar w/ examples Documentation request: How to create a custom grammar Jan 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant