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

Rewrite the docs #61

Open
JuanjoSalvador opened this issue Oct 8, 2018 · 22 comments
Open

Rewrite the docs #61

JuanjoSalvador opened this issue Oct 8, 2018 · 22 comments

Comments

@JuanjoSalvador
Copy link
Contributor

@JuanjoSalvador JuanjoSalvador commented Oct 8, 2018

Documentation seems a bit confused. We need to write a tutorial,how install Blask and how to start using it!

@zerasul

This comment has been minimized.

Copy link
Owner

@zerasul zerasul commented Oct 8, 2018

You can use too the #55 issue.

@Amruta-Ranade

This comment has been minimized.

Copy link

@Amruta-Ranade Amruta-Ranade commented Oct 12, 2018

I would like to help with the Getting Started docs!

@zerasul

This comment has been minimized.

Copy link
Owner

@zerasul zerasul commented Oct 12, 2018

I would like to help with the Getting Started docs!

Hi Amruta; of course you can help only you need to do is send an Pull Request, and i will accept it later. Also, if you need more help, please ask what you need.

@Amruta-Ranade

This comment has been minimized.

Copy link

@Amruta-Ranade Amruta-Ranade commented Oct 12, 2018

Thanks! I am planning a video documenting my writing process while contributing to open source projects. The intention is to help others contribute docs to open source projects. Is it okay if I document my writing process for the Getting Started guide?

@zerasul

This comment has been minimized.

Copy link
Owner

@zerasul zerasul commented Oct 13, 2018

Hi!

Of course its okay to writting the process!! And any help that we can offer you, please ask us.

@Amruta-Ranade

This comment has been minimized.

Copy link

@Amruta-Ranade Amruta-Ranade commented Oct 19, 2018

Hello..I am swamped with my day job-related work, but just wanted to let you know that I have started working on the docs for Blask in whatever free time I get. I hope to invest more time on this project once I get some more free time in the next few weeks.

@zerasul

This comment has been minimized.

Copy link
Owner

@zerasul zerasul commented Oct 19, 2018

Hi Amruta:

Don't worry feel free to work when you can. And remember if you have any question, feel free to ask us,

Of course, thanks for your help.

@Amruta-Ranade

This comment has been minimized.

Copy link

@Amruta-Ranade Amruta-Ranade commented Nov 3, 2018

Hello! I need help figuring out the commands to run the project. I tried following the instructions on the Install page, but got errors:

pip install blask gave the error:
Collecting blask
Could not fetch URL https://pypi.python.org/simple/blask/: There was a problem confirming the ssl certificate: [SSL: TLSV1_ALERT_PROTOCOL_VERSION] tlsv1 alert protocol version (_ssl.c:661) - skipping
Could not find a version that satisfies the requirement blask (from versions: )
No matching distribution found for blask

pip install -r requirements.txt gave the error:
Could not open requirements file: [Errno 2] No such file or directory: 'requirements.txt'

Can you help me figure out the correct commands?

@JuanjoSalvador

This comment has been minimized.

Copy link
Contributor Author

@JuanjoSalvador JuanjoSalvador commented Nov 3, 2018

The first pip error seems a error with the PIP itself. Can you tell us the version of pip are you using?

pip --version

And the second error, maybe it's because you have to clone the repo and move into it

git clone https://github.com/zerasul/blask.git && mv blask
@Amruta-Ranade

This comment has been minimized.

Copy link

@Amruta-Ranade Amruta-Ranade commented Nov 3, 2018

Thanks for the quick response!

The pip version I am using is: pip 9.0.1 from /Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages (python 2.7)

About cloning the repo, the instructions indicated that cloning the repo was an optional step. Am I mistaken? 🤔

@Amruta-Ranade

This comment has been minimized.

Copy link

@Amruta-Ranade Amruta-Ranade commented Nov 3, 2018

I realized I was using python2.7 instead of python3. I used pip3 instead of pip, and it worked fine! :)

@Amruta-Ranade

This comment has been minimized.

Copy link

@Amruta-Ranade Amruta-Ranade commented Nov 3, 2018

I created the settings.py file and tried running blaskcli init and blaskcli run (The docs say I can use the cli command because I installed blask using pip). Getting the following error:

Traceback (most recent call last):
File "/Library/Frameworks/Python.framework/Versions/3.6/bin/blaskcli", line 11, in
load_entry_point('Blask==0.1.0', 'console_scripts', 'blaskcli')()
File "/Library/Frameworks/Python.framework/Versions/3.6/lib/python3.6/site-packages/pkg_resources/init.py", line 565, in load_entry_point
return get_distribution(dist).load_entry_point(group, name)
File "/Library/Frameworks/Python.framework/Versions/3.6/lib/python3.6/site-packages/pkg_resources/init.py", line 2631, in load_entry_point
return ep.load()
File "/Library/Frameworks/Python.framework/Versions/3.6/lib/python3.6/site-packages/pkg_resources/init.py", line 2291, in load
return self.resolve()
File "/Library/Frameworks/Python.framework/Versions/3.6/lib/python3.6/site-packages/pkg_resources/init.py", line 2297, in resolve
module = import(self.module_name, fromlist=['name'], level=0)
File "/Library/Frameworks/Python.framework/Versions/3.6/lib/python3.6/site-packages/Blask/blaskcli.py", line 44, in
blask = BlaskApp()
File "/Library/Frameworks/Python.framework/Versions/3.6/lib/python3.6/site-packages/Blask/blaskapp.py", line 36, in init
self.settings = BlaskSettings(**kwargs)
File "/Library/Frameworks/Python.framework/Versions/3.6/lib/python3.6/site-packages/Blask/blasksettings.py", line 48, in init
0)
ModuleNotFoundError: No module named 'settings'

@zerasul

This comment has been minimized.

Copy link
Owner

@zerasul zerasul commented Nov 3, 2018

Hi Amruta:

It seems that you need to export the BLASK_SETTINGS enviroment variable.

export BLASK_SETTINGS = settings

try to execute the run command after export the variable.

@Amruta-Ranade

This comment has been minimized.

Copy link

@Amruta-Ranade Amruta-Ranade commented Nov 3, 2018

I did export BLASK_SETTINGS=settings.py like the docs say. And also tried your suggestion. Still no success.

@Amruta-Ranade

This comment has been minimized.

Copy link

@Amruta-Ranade Amruta-Ranade commented Nov 3, 2018

Here's what I have tried so far:
https://docs.google.com/document/d/1RV_ofUmInbdsTE-JlGCO26C0UJjxErk4ykYBLJWu20A/edit?usp=sharing

Stuck on the blaskcli command

@zerasul

This comment has been minimized.

Copy link
Owner

@zerasul zerasul commented Nov 4, 2018

Hi:

thanks for all the info!! it's a great job!!

Im going to check what happends with the export variable. meanwhile you can run Blask using the source code.

i see in the document:

Then tried `export BLASK_SETTINGS=settings.py` on the Install page. That worked! So the Home page text has an error

So now you can run Blask using the export command?

Im going to check all the documentation and focus on the correct spelling of the commands.

Again thanks for your work.

@zerasul zerasul added this to To do in 0.1.1 via automation Nov 4, 2018
@Amruta-Ranade

This comment has been minimized.

Copy link

@Amruta-Ranade Amruta-Ranade commented Nov 4, 2018

Thank you!

I would rather document the non-source code method, since that's what most people would want to use. Following is the workflow I want to document (because it's the simplest one and will help users get productive faster):

  1. pip install blask
  2. Create settings.py (here, I am confused about the two versions of settings.py. One of them starts with import os and is much more detailed than the other that only lists the variables. Please recommend the correct one to use)
  3. Export environment variable
  4. blaskcli init
  5. blaskcli run
@zerasul

This comment has been minimized.

Copy link
Owner

@zerasul zerasul commented Nov 4, 2018

Hi:

Im checking the documentation and see where is the error. Im creating a new release with some fixes and im going to upload it in a very short time (one or two days).

I see the workflow and sounds great! The correct use of settings.py is with the import os thats because the settings.py variables needs the path of the folders that is needed for blask.

Im going to fix the documentation in the next days.

Again thanks for your effort.

@Amruta-Ranade

This comment has been minimized.

Copy link

@Amruta-Ranade Amruta-Ranade commented Nov 4, 2018

Excellent! Thank you so much! I look forward to the new release :)

@zerasul zerasul moved this from To do to In progress in 0.1.1 Nov 7, 2018
zerasul added a commit that referenced this issue Nov 7, 2018
@zerasul

This comment has been minimized.

Copy link
Owner

@zerasul zerasul commented Nov 7, 2018

Hi:

Im still working on the new release and im triying to fix an error on the enviroment variable module loading.

Also, im Fixing the errors on the documentation for the web. (Im following the advices of @Amruta-Ranade document; thanks!! )

I will have news soon!!!

@Amruta-Ranade

This comment has been minimized.

Copy link

@Amruta-Ranade Amruta-Ranade commented Nov 9, 2018

Sounds great! Let me know when you fix the environment variable error. I can then start drafting the documentation and open a PR :)

@zerasul

This comment has been minimized.

Copy link
Owner

@zerasul zerasul commented Dec 7, 2018

Hello everybody:

At last, i have some free-time and can fix the error when you try to run Black with the BLASK_SETTINGS environment variable. ( I Upload to pip the 0.1.1b6 version) this afternoon im going to upload the release version after check there is no errors and the linter pass ok (also sonar cloud).

Sorry for the delay but i was without free-time in the past weeks.

And also, im going to update the web with all the last changes.

zerasul pushed a commit that referenced this issue Dec 7, 2018
Victor Suarez
@zerasul zerasul added this to To do in Blask 0.1.3 via automation Oct 6, 2019
@zerasul zerasul removed this from In progress in 0.1.1 Oct 6, 2019
zerasul added a commit that referenced this issue Oct 7, 2019
@zerasul zerasul removed this from To do in Blask 0.1.3 Nov 25, 2019
@zerasul zerasul added this to To do in Blask 0.2.0 via automation Nov 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Blask 0.2.0
  
To do
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.